Synchronet now requires the libarchive development package (e.g. libarchive-dev on Debian-based Linux distros, libarchive.org for more info) to build successfully.

ODPlat.c 45.5 KB
Newer Older
rswindell's avatar
rswindell committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/* OpenDoors Online Software Programming Toolkit
 * (C) Copyright 1991 - 1999 by Brian Pirie.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
Deucе's avatar
Deucе committed
16
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
rswindell's avatar
rswindell committed
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
 *
 *
 *        File: ODPlat.c
 *
 * Description: Contains platform-specific utility functions. Non-platform
 *              specific utility functions are implemented in odutil.c
 *
 *   Revisions: Date          Ver   Who  Change
 *              ---------------------------------------------------------------
 *              Oct 14, 1994  6.00  BP   Created, with od_yield().
 *              Nov 01, 1994  6.00  BP   Added new directory access functions.
 *              Dec 09, 1994  6.00  BP   Eliminate access to old dir functions.
 *              Dec 31, 1994  6.00  BP   Added timing, file delete functions.
 *              Dec 31, 1994  6.00  BP   Remove #ifndef USEINLINE DOS code.
 *              Dec 31, 1994  6.00  BP   Added ODMultitasker and ODPlatInit()
 *              Nov 14, 1995  6.00  BP   32-bit portability.
 *              Nov 16, 1995  6.00  BP   Removed oddoor.h, added odcore.h.
 *              Nov 17, 1995  6.00  BP   Added multithreading functions.
 *              Nov 21, 1995  6.00  BP   Ported to Win32.
 *              Dec 12, 1995  6.00  BP   Added entry, exit and kernel macros.
 *              Dec 13, 1995  6.00  BP   Added ODThreadWaitForExit().
 *              Dec 13, 1995  6.00  BP   Added ODThreadGetCurrent().
 *              Dec 19, 1995  6.00  BP   Fixed ODThreadGetCurrent() (Win32).
 *              Dec 30, 1995  6.00  BP   Added ODCALL for calling convention.
 *              Jan 23, 1996  6.00  BP   Added ODProcessExit().
 *              Jan 30, 1996  6.00  BP   Replaced od_yield() with od_sleep().
 *              Jan 30, 1996  6.00  BP   Add semaphore timeout.
 *              Jan 31, 1996  6.00  BP   Add ODTimerLeft(), rm ODTimerSleep().
 *              Feb 19, 1996  6.00  BP   Changed version number to 6.00.
 *              Mar 03, 1996  6.10  BP   Begin version 6.10.
 *              Mar 06, 1996  6.10  BP   Prevent TC calls N_LXMUL@ & N_LXDIV@.
 *              Mar 19, 1996  6.10  BP   MSVC15 source-level compatibility.
49
 *              Aug 10, 2003  6.23  SH   *nix support
rswindell's avatar
rswindell committed
50 51 52 53 54 55 56 57 58 59 60
 */

#define BUILDING_OPENDOORS

#include <stdio.h>
#include <stdlib.h>
#include <time.h>
#include <ctype.h>
#include <string.h>

#include "OpenDoor.h"
deuce's avatar
deuce committed
61 62 63 64 65
#ifdef ODPLAT_NIX
#include <sys/time.h>
#include <glob.h>
#include <sys/types.h>
#include <sys/stat.h>
66
#include <unistd.h>
deuce's avatar
deuce committed
67
#endif
rswindell's avatar
rswindell committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
#include "ODGen.h"
#include "ODCore.h"
#include "ODPlat.h"
#include "ODUtil.h"
#include "ODSwap.h"
#include "ODKrnl.h"

#ifdef ODPLAT_WIN32
#include "windows.h"
#endif /* ODPLAT_WIN32 */


/* Multitasker type, only availvable under DOS. */
#ifdef ODPLAT_DOS
tODMultitasker ODMultitasker = kMultitaskerNone;
static void ODPlatYield(void);
#endif /* ODPLAT_DOS */

/* ----------------------------------------------------------------------------
 * ODPlatInit()
 *
 * Performs any initialization required to use the utility functions supplied
 * by this module.
 *
 * Parameters: none
 *
 *     Return: void
 */
void ODPlatInit(void)
{
#ifdef ODPLAT_DOS
   /* If this is the DOS version of OpenDoors, then ODPlatInit() must */
   /* determine what multitasker we are running under.                */

   /* Check whether running under OS/2. */
   ASM       mov ah, 0x30
   ASM       int 0x21
   ASM       cmp al, 0x0a
   ASM       jl  NoOS2

   /* If we get to this point, then OS/2 has been detected. */
   ODMultitasker = kMultitaskerOS2;
   return;

NoOS2:
   /* Check whether we are running under DesqView. */
   ASM    mov cx, 0x4445
   ASM    mov dx, 0x5351
   ASM    mov ax, 0x2b01
   ASM    int 0x21
   ASM    cmp al, 0xff
   ASM    je NoDesqView

   /* If we get to this point, then DesqView has been detected. */
   ODMultitasker = kMultitaskerDV;

NoDesqView:
   /* Check whether we are running under Windows. */
   ASM    push di
   ASM    push si
   ASM    mov ax, 0x1600
   ASM    int 0x2f
   ASM    pop si
   ASM    pop di
   ASM    cmp al, 0x00
   ASM    je NoWindows
   ASM    cmp al, 0x80
   ASM    je NoWindows

    /* If we get to this point, then Windows has been detected. */
   ODMultitasker = kMultitaskerWin;

NoWindows:
   ODMultitasker = kMultitaskerNone;
#endif /* ODPLAT_DOS */
}


/* ----------------------------------------------------------------------------
 * ODPlatYield()                                       *** PRIVATE FUNCTION ***
 *
 * Yields control to other tasks when running as a DOS application under a
 * multitasking system.
 *
 * Parameters: none
 *
 *     Return: void
 */
#ifdef ODPLAT_DOS
static void ODPlatYield(void)
{
   switch(ODMultitasker)
   {
      case kMultitaskerDV:
         ASM  mov ax, 0x1000
         ASM  int 0x15
         break;

      case kMultitaskerWin:
         ASM  mov ax, 0x1680
         ASM  int 0x2f
         break;

      case kMultitaskerOS2:
      default:
         ASM  int 0x28
   }
}
#endif /* ODPLAT_DOS */


/* ========================================================================= */
/* Multithreading and synchronization support.                               */
/* ========================================================================= */

#ifdef OD_MULTITHREADED

/* ----------------------------------------------------------------------------
 * ODThreadCreate()
 *
 * Starts a new thread of concurrent execution.
 *
 * Parameters: phThread      - Pointer to the location where the handle to the
 *                             new thread should be stored.
 *
 *             pfThreadProc  - Function to call to begin execution of the
 *                             thread.
 *
 *             pThreadParam  - Parameter to pass to the thread function when
 *                             it is called.
 *
 *     Return: kOCRCSuccess on success, or an error code on failure.
 */
tODResult ODThreadCreate(tODThreadHandle *phThread,
   ptODThreadProc *pfThreadProc, void *pThreadParam)
{
#ifdef ODPLAT_WIN32
   DWORD dwThreadID;
   HANDLE hNewThread;

   ASSERT(phThread != NULL);
   ASSERT(pfThreadProc != NULL);
   
   /* Attempt to create the new thread. */
   hNewThread = CreateThread(NULL, 0, pfThreadProc, pThreadParam,
      0, &dwThreadID);

   /* Check for thread creation failure. */
   if(hNewThread == NULL)
   {
      return(kODRCGeneralFailure);
   }

   /* Pass newly created thread's handle back to the caller. */
   *phThread = hNewThread;

   /* Return with success. */
   return(kODRCSuccess);
#endif /* ODPLAT_WIN32 */
}


/* ----------------------------------------------------------------------------
 * ODThreadExit()
 *
 * Causes the calling thread to be terminated.
 *
 * Parameters: none
 *
 *     Return: Never returns!
 */
void ODThreadExit()
{
#ifdef ODPLAT_WIN32
   ExitThread(0);
#endif /* ODPLAT_WIN32 */

   /* We should never get here. */
   ASSERT(FALSE);
}


/* ----------------------------------------------------------------------------
 * ODThreadTerminate()
 *
 * Terminates the specified thread. 
 *
 * Parameters: hThread - Handle to the thread to be terminated.
 *
 *     Return: kOCRCSuccess on success, or an error code on failure.
 */
tODResult ODThreadTerminate(tODThreadHandle hThread)
{
   ASSERT(hThread != NULL);

#ifdef ODPLAT_WIN32
   return(TerminateThread(hThread, 0) ? kODRCSuccess : kODRCGeneralFailure);
#endif /* ODPLAT_WIN32 */
}


/* ----------------------------------------------------------------------------
 * ODThreadSuspend()
 *
 * Pauses execution of the specified thread, until the ODThreadResume()
 * function is called.
 *
 * Parameters: hThread - Handle to the thread to be suspended.
 *
 *     Return: kOCRCSuccess on success, or an error code on failure.
 */
tODResult ODThreadSuspend(tODThreadHandle hThread)
{
   ASSERT(hThread != NULL);

#ifdef ODPLAT_WIN32
   return(SuspendThread(hThread) == 0xFFFFFFFF ? kODRCGeneralFailure
      : kODRCSuccess);
#endif /* ODPLAT_WIN32 */
}


/* ----------------------------------------------------------------------------
 * ODThreadResume()
 *
 * Continues execution of a thread previously paused by a call to
 * ODThreadSuspend().
 *
 * Parameters: hThread - Handle to the thread to be resumed.
 *
 *     Return: kOCRCSuccess on success, or an error code on failure.
 */
tODResult ODThreadResume(tODThreadHandle hThread)
{
   ASSERT(hThread != NULL);

#ifdef ODPLAT_WIN32
   return(ResumeThread(hThread) == 0xFFFFFFFF ? kODRCGeneralFailure
      : kODRCSuccess);
#endif /* ODPLAT_WIN32 */
}


/* ----------------------------------------------------------------------------
 * ODThreadSetPriority()
 *
 * Changes the execution priority of a thread. Since the exact semantics of
 * thread priorities are different for each platform, this function should
 * be used carefully. The caller should assume that no thread will run if there
 * exists a non-blocked thread with a higher priority.
 *
 * Parameters: hThread        - Handle to the thread to change the priority of.
 *
 *             ThreadPriority - New priority to assign to the thread.
 *
 *     Return: kOCRCSuccess on success, or an error code on failure.
 */
tODResult ODThreadSetPriority(tODThreadHandle hThread,
   tODThreadPriority ThreadPriority)
{
#ifdef ODPLAT_WIN32
   int nWindowsThreadPriority;

   ASSERT(hThread != NULL);

   /* Determine the Windows thread priority to assign to the thread. */
   switch(ThreadPriority)   
   {
      case OD_PRIORITY_LOWEST:
         nWindowsThreadPriority = THREAD_PRIORITY_LOWEST;
         break;
      case OD_PRIORITY_BELOW_NORMAL:
         nWindowsThreadPriority = THREAD_PRIORITY_BELOW_NORMAL;
         break;
      case OD_PRIORITY_NORMAL:
         nWindowsThreadPriority = THREAD_PRIORITY_NORMAL;
         break;
      case OD_PRIORITY_ABOVE_NORMAL:
         nWindowsThreadPriority = THREAD_PRIORITY_ABOVE_NORMAL;
         break;
      case OD_PRIORITY_HIGHEST:
         nWindowsThreadPriority = THREAD_PRIORITY_HIGHEST;
         break;
      default:
         ASSERT(FALSE);
   }

   /* Update the thread's priority. */
   return(SetThreadPriority(hThread, nWindowsThreadPriority)
      ? kODRCSuccess : kODRCGeneralFailure);

#endif /* ODPLAT_WIN32 */
}


/* ----------------------------------------------------------------------------
 * ODThreadWaitForExit()
 *
 * Blocks until the specified thread is terminated.
 *
 * Parameters: hThread - Handle to the thread to wait for.
 *
 *     Return: void
 */
void ODThreadWaitForExit(tODThreadHandle hThread)
{
#ifdef ODPLAT_WIN32
   WaitForSingleObject(hThread, INFINITE);
#endif /* ODPLAT_WIN32 */
}


/* ----------------------------------------------------------------------------
 * ODThreadGetCurrent()
 *
 * Obtains a handle to the thread that called this function.
 *
 * Parameters: None.
 *
 *     Return: Handle to the current thread.
 */
tODThreadHandle ODThreadGetCurrent(void)
{
#ifdef ODPLAT_WIN32
   HANDLE hDuplicate;
   if(!DuplicateHandle(GetCurrentProcess(), GetCurrentThread(),
      GetCurrentProcess(), &hDuplicate, 0, FALSE, DUPLICATE_SAME_ACCESS))
   {
      return(NULL);
   }
   return(hDuplicate);
#endif /* ODPLAT_WIN32 */
}


/* ----------------------------------------------------------------------------
 * ODSemaphoreAlloc()
 *
 * Allocates a semaphore synchronization object.
 *
 * Parameters: phSemaphore   - Pointer to location where the handle to the
 *                             newly created semaphore should be stored.
 *
 *             nInitialCount - Initial value to assign to the semaphore.
 *
 *             nMaximumCount - Maximum value that the semaphore may have
 *                             (if supported by the current platform).
 *
 *     Return: kOCRCSuccess on success, or an error code on failure.
 */
tODResult ODSemaphoreAlloc(tODSemaphoreHandle *phSemaphore, INT nInitialCount,
   INT nMaximumCount)
{
   ASSERT(phSemaphore != NULL);
   ASSERT(nInitialCount >= 0);
   ASSERT(nMaximumCount >= nInitialCount);

#ifdef ODPLAT_WIN32
   *phSemaphore = CreateSemaphore(NULL, (LONG)nInitialCount,
      (LONG)nMaximumCount, NULL);

   return(*phSemaphore == NULL ? kODRCGeneralFailure : kODRCSuccess);
#endif /* ODPLAT_WIN32 */
}


/* ----------------------------------------------------------------------------
 * ODSemaphoreFree()
 *
 * Deallocates a semaphore that we previously created by ODSemaphoreAlloc().
 *
 * Parameters: hSemaphore - Handle to semaphore to deallocate.
 *
 *     Return: void
 */
void ODSemaphoreFree(tODSemaphoreHandle hSemaphore)
{
   ASSERT(hSemaphore != NULL);

#ifdef ODPLAT_WIN32
   DeleteObject(hSemaphore);
#endif /* ODPLAT_WIN32 */
}


/* ----------------------------------------------------------------------------
 * ODSemaphoreUp()
 *
 * Increments the count of the specified semaphore.
 *
 * Parameters: hSemaphore   - Semaphore to increment.
 *
 *             nIncrementBy - Amount to add to the semaphore's current value.
 *
 *     Return: void
 */
void ODSemaphoreUp(tODSemaphoreHandle hSemaphore, INT nIncrementBy)
{
   ASSERT(hSemaphore != NULL);
   ASSERT(nIncrementBy > 0);

#ifdef ODPLAT_WIN32
   ReleaseSemaphore(hSemaphore, nIncrementBy, NULL);
#endif /* ODPLAT_WIN32 */
}


/* ----------------------------------------------------------------------------
 * ODSemaphoreDown()
 *
 * Decrements the count of the specified semaphore. A semaphore may never have
 * a value less than 0. Hence, an attempt to decrement the value of a
 * semaphore below zero will cause the calling thread to be blocked until some
 * other thread increments the semaphore.
 *
 * Parameters: hSemaphore   - Handle to the semaphore to decrement.
 *
 *             Timeout      - Maximum time to wait for the semaphore to be
 *                            incremented, or OD_NO_TIMEOUT to prevent this
 *                            function from returning before the semaphore is
 *                            incremented.
 *
 *     Return: kODRCSuccess, or kODRCTimeout if the semaphore was not
 *             decremented before Timeout milliseconds elapsed.
 */
tODResult ODSemaphoreDown(tODSemaphoreHandle hSemaphore, tODMilliSec Timeout)
{
   ASSERT(hSemaphore != NULL);

#ifdef ODPLAT_WIN32
498
   if(WaitForSingleObject(hSemaphore, Timeout) != WAIT_OBJECT_0)
rswindell's avatar
rswindell committed
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
   {
      return(kODRCTimeout);
   }
#endif /* ODPLAT_WIN32 */

   /* Return with success. */
   return(kODRCSuccess);
}

#endif /* OD_MULTITHREADED */


/* ----------------------------------------------------------------------------
 * ODProcessExit()
 *
 * Ends the current process.
 *
 * Parameters: nExitCode - Exit code to return to the calling process.
 *
 *     Return: Never returns.
 */
void ODProcessExit(INT nExitCode)
{
#ifdef ODPLAT_WIN32
   ExitProcess(nExitCode);
#else /* !ODPLAT_WIN32 */
   exit(nExitCode);
#endif /* !ODPLAT_WIN32 */
}


/* ========================================================================= */
/* Millisecond timer functions.                                              */
/* ========================================================================= */

#ifdef ODPLAT_DOS
/* For the DOS platform, we need to know the number of milliseconds per */
/* clock tick.                                                          */
#define MILLISEC_PER_TICK 55           /* (approx. == 1000 / CLOCKS_PER_SEC) */
#endif /* ODPLAT_DOS */

/* ----------------------------------------------------------------------------
 * ODTimerStart()
 *
 * Starts a timer for a specified number of milliseconds. Future calls to
 * ODTimerElapsed() can be used to determine whether or not specified time
 * has elapsed. Note that while this function accepts its parameter in
 * milliseconds, it does not gurantee millisecond resolution. In fact, under
 * DOS, this timer mechanism has just under a 55 millisecond resolution, with
 * an average error of about 27 milliseconds.
 *
 * Parameters: pTimer   - Pointer to a tODTimer structure that will be later
 *                        passed to ODTimerElapsed().
 *
 *             Duration - Number of milliseconds after which timer should
 *                        elapse.
 *
 *     Return: void
 */
void ODTimerStart(tODTimer *pTimer, tODMilliSec Duration)
{
deuce's avatar
deuce committed
560 561 562
#ifdef ODPLAT_NIX
   struct timeval tv;
#endif
rswindell's avatar
rswindell committed
563 564 565 566 567 568 569 570 571 572 573 574 575 576
   ASSERT(pTimer != NULL);
   ASSERT(Duration >= 0);

#ifdef ODPLAT_DOS
   /* Store timer start time right away. */
   pTimer->Start = clock();

   /* Calculate duration of timer. */
   ODDWordDivide((DWORD *)&pTimer->Duration, NULL, Duration,
      MILLISEC_PER_TICK);
#endif /* ODPLAT_DOS */

#ifdef ODPLAT_WIN32
   /* Store timer start time now. */
577
   pTimer->Start = GetTickCount();
rswindell's avatar
rswindell committed
578 579
   pTimer->Duration = Duration;
#endif /* ODPLAT_WIN32 */
deuce's avatar
deuce committed
580 581

#ifdef ODPLAT_NIX
582
   gettimeofday(&tv,NULL);
583
   pTimer->Start=tv.tv_sec*1000+tv.tv_usec/1000;
deuce's avatar
deuce committed
584 585
   pTimer->Duration = Duration;
#endif
rswindell's avatar
rswindell committed
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
}


/* ----------------------------------------------------------------------------
 * ODTimerElapsed()
 *
 * Determines whether or not a timer set by ODTimerStart() has elapsed.
 *
 * Parameters: pTimer - Pointer to a tODTimer structure that was populated
 *                      by ODTimerStart().
 *
 *     Return: TRUE if timer has elapsed, FALSE if it has not.
 */
BOOL ODTimerElapsed(tODTimer *pTimer)
{
   ASSERT(pTimer != NULL);

#ifdef ODPLAT_DOS
   return(clock() > pTimer->Start + pTimer->Duration
      || clock() < pTimer->Start);
#endif /* ODPLAT_DOS */

#ifdef ODPLAT_WIN32
609
   return(ODTimerLeft(pTimer)==0);
rswindell's avatar
rswindell committed
610
#endif /* ODPLAT_WIN32 */
deuce's avatar
deuce committed
611 612

#ifdef ODPLAT_NIX
613
	return(ODTimerLeft(pTimer)==0);
deuce's avatar
deuce committed
614
#endif
rswindell's avatar
rswindell committed
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
}


/* ----------------------------------------------------------------------------
 * ODTimerWaitForElapse()
 *
 * Sleeps until the specified timer elapses.
 *
 * Parameters: pTimer - Pointer to a tODTimer structure that was populated
 *                      by ODTimerStart().
 *
 *     Return: void
 */
void ODTimerWaitForElapse(tODTimer *pTimer)
{
   ASSERT(pTimer != NULL);

#ifdef ODPLAT_DOS

   /* Under DOS, our timer resolution is low enough (only 18.2 ticks per    */
   /* second), that we cannot accurately calculate the time to sleep for.   */
   /* For this reason, we simply loop until the timer has elapsed, yielding */
   /* control to other tasks if when the timer has not elapsed.             */

   /* While timer has not elapsed. */
   while(!ODTimerElapsed(pTimer))
   {
      /* Let other tasks run. */
      od_sleep(0);
   }

#else /* !ODPLAT_DOS */
deuce's avatar
deuce committed
647 648 649
   /* Under other platforms, timer resolution is high enough that we can */
   /* ask the OS to block this thread for the amount of time required    */
   /* for the timer to elapse.                                           */
rswindell's avatar
rswindell committed
650

deuce's avatar
deuce committed
651
   od_sleep(ODTimerLeft(pTimer));
rswindell's avatar
rswindell committed
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
#endif /* !ODPLAT_DOS */
}


/* ----------------------------------------------------------------------------
 * ODTimerLeft()
 *
 * Determines the number of milliseconds left before the timer elapses.
 *
 * Parameters: pTimer - Pointer to a tODTimer structure that was populated
 *                      by ODTimerStart().
 *
 *     Return: Number of milliseconds before timer elapses, or 0 if the timer
 *             has already elapsed.
 */
tODMilliSec ODTimerLeft(tODTimer *pTimer)
{
deuce's avatar
deuce committed
669 670
#ifdef ODPLAT_NIX
   struct timeval tv;
671
   time_t nowtick;
deuce's avatar
deuce committed
672
#endif
rswindell's avatar
rswindell committed
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
   ASSERT(pTimer != NULL);

#ifdef ODPLAT_DOS
   {
      clock_t Now = clock();
      clock_t Left;

      /* If timer has elapsed, return 0. */
      if(Now > pTimer->Start + pTimer->Duration
         || Now < pTimer->Start)
      {
         return(0);
      }

      Left = pTimer->Start + pTimer->Duration - Now;

      return(ODDWordMultiply(Left, MILLISEC_PER_TICK));
   }
deuce's avatar
deuce committed
691 692
#elif defined(ODPLAT_NIX)
   gettimeofday(&tv,NULL);
693 694
   nowtick=tv.tv_sec*1000+(tv.tv_usec/1000);
   if(pTimer->Start+pTimer->Duration <= nowtick)
695
      return(0);
696
   return((tODMilliSec)(pTimer->Start + pTimer->Duration - nowtick));
rswindell's avatar
rswindell committed
697 698 699 700 701
#else /* !ODPLAT_DOS */
   {
      tODMilliSec Now;

#ifdef ODPLAT_WIN32      
702
      Now = GetTickCount();
rswindell's avatar
rswindell committed
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
#endif /* ODPLAT_WIN32 */

      /* If timer has elapsed, return 0. */
      if(Now > pTimer->Start + pTimer->Duration
         || Now < pTimer->Start)
      {
         return(0);
      }

      return(pTimer->Start + pTimer->Duration - Now);
   }
#endif /* !ODPLAT_DOS */
}


/* ----------------------------------------------------------------------------
 * od_sleep()
 *
 * Sleeps for the specified number of milliseconds, being as friendly to other
 * running tasks as possible. Under DOS, this function uses the ODTimerStart()/
 * ODTimerElapsed() mechanism, and so its accuracy is limited by the accuracy
 * of that mechanism.
 *
 * Parameters: Milliseconds - Number of milliseconds to sleep. A value of 0
 *                            allows any other waiting processes to run for
 *                            the rest of the current timeslice.
 *
 *     Return: void
 */
ODAPIDEF void ODCALL od_sleep(tODMilliSec Milliseconds)
{
deuce's avatar
deuce committed
734 735
#ifdef ODPLAT_NIX
   struct timeval tv;
736
   struct timeval start;
737 738
   time_t started;
   time_t left
deuce's avatar
deuce committed
739
#endif
rswindell's avatar
rswindell committed
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
   /* Log function entry if running in trace mode. */
   TRACE(TRACE_API, "od_sleep()");

   /* Ensure that OpenDoors is initialized before proceeding. */
   if(!bODInitialized) od_init();

   OD_API_ENTRY();

#ifdef ODPLAT_DOS
   if(Milliseconds == 0)
   {
      ODPlatYield();
   }
   else
   {
      tODTimer SleepTimer;
      ODTimerStart(&SleepTimer, Milliseconds);
      while(!ODTimerElapsed(&SleepTimer))
      {
         /* Let other tasks run. */
         ODPlatYield();
      }
   }
#endif /* ODPLAT_DOS */

#ifdef ODPLAT_WIN32
   Sleep(Milliseconds);
#endif /* ODPLAT_WIN32 */

deuce's avatar
deuce committed
769
#ifdef ODPLAT_NIX
770
   if(Milliseconds==0)  {
771 772
      /* Prevent 100% CPU *only* no delay is actually required here */
      tv.tv_sec=0;
773
      tv.tv_usec=1000;
774 775 776 777
      select(0,NULL,NULL,NULL,&tv);
   }
   else  {
      gettimeofday(&start,NULL);
deuce's avatar
deuce committed
778
	  started=start.tv_sec*1000+(start.tv_usec/1000);
779 780 781 782

      while(1)  {
	     /* This is timing sensitive and *MUST* wait for at least Milliseconds regardless of 100% CPU or signals */
         gettimeofday(&tv,NULL);
deuce's avatar
deuce committed
783 784 785 786 787
		 left=tv.tv_sec*1000+(tv.tv_usec/1000);
		 left-=started;
		 left=Milliseconds-left;
         tv.tv_sec = left/1000;
         tv.tv_usec = (left*1000)%1000000;
788 789 790 791 792
         if(tv.tv_sec<0 || tv.tv_usec<0)
            break;
         if(!select(0,NULL,NULL,NULL,&tv))
            break;
      }
793
   }
deuce's avatar
deuce committed
794 795
#endif

rswindell's avatar
rswindell committed
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
   OD_API_EXIT();
}


/* ========================================================================= */
/* Directory access.                                                         */
/* ========================================================================= */

/* Structure for directories entries returned by DOS. */
#ifdef ODPLAT_DOS
typedef struct
{
   BYTE abtReserved[21];
   BYTE btAttrib;
   WORD wFileTime;
   WORD wFileDate;
   DWORD dwFileSize;
   char szFileName[13];
} tDOSDirEntry;
#endif /* ODPLAT_DOS */


/* Dir handle structure. */
typedef struct
{
   BOOL bEOF;
#ifdef ODPLAT_DOS
   tDOSDirEntry FindBlock;
#endif /* ODPLAT_DOS */
#ifdef ODPLAT_WIN32
   HANDLE hWindowsDir;
   WIN32_FIND_DATA WindowsDirEntry;
   int wAttributes;
#endif /* ODPLAT_WIN32 */
deuce's avatar
deuce committed
830 831 832 833 834
#ifdef ODPLAT_NIX
   glob_t	g;
   int		pos;
   int		wAttributes;
#endif
rswindell's avatar
rswindell committed
835 836 837 838
} tODDirInfo;


/* Directory access private function prototypes. */
839
#if defined(ODPLAT_DOS) || defined(ODPLAT_WIN32)
rswindell's avatar
rswindell committed
840
static time_t DOSToCTime(WORD wDate, WORD wTime);
841
#endif
rswindell's avatar
rswindell committed
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
#ifdef ODPLAT_DOS
static INT ODDirDOSFindFirst(CONST char *pszPath, tDOSDirEntry *pBlock,
   WORD wAttributes);
static INT ODDirDOSFindNext(tDOSDirEntry *pBlock);
#endif /* ODPLAT_DOS */
#ifdef ODPLAT_WIN32
static BOOL ODDirWinMatchesAttributes(tODDirInfo *pDirInfo);
#endif /* ODPLAT_WIN32 */


/* ----------------------------------------------------------------------------
 * ODDirOpen()
 *
 * Opens a directory for future access using ODDirRead(). On Success,
 * ODDirOpen() provides a directory handle that represents a list of directory
 * entries that match the specified path and attributes. When finished with
 * the directory handle, the caller should release it using ODDirClose().
 *
 * Parameters: pszPath     - Directory with filename (wildcards are supported),
 *                           for which matching files should be found. If there
 *                           are no matching files, ODDirOpen() returns with
 *                           kODRCNoMatch.
 *
 *             nAttributes - One or more of the DIR_ATTRIB_... constants,
 *                           connected by the bitmap-OR (|) operator.
 *
 *             phDir       - Pointer to a tODDirHandle, into which ODDirOpen()
 *                           will place a valid directory handle if and only
 *                           if it returns kODRCSuccess.
 *
 *     Return: A tODResult indicating success or reason for failure.
 */
tODResult ODDirOpen(CONST char *pszPath, WORD wAttributes, tODDirHandle *phDir)
{
   tODDirInfo *pDirInfo;

   ASSERT(pszPath != NULL);
   ASSERT(phDir != NULL);

   /* Attempt to allocate a directory information structure. */
   if((pDirInfo = malloc(sizeof(tODDirInfo))) == NULL)
   {
      /* If unable to allocate enough memory, return this state to the */
      /* caller. */
      return(kODRCNoMemory);
   }

   /* Initialize directory information structure. */
   pDirInfo->bEOF = FALSE;

#ifdef ODPLAT_DOS
   /* Read the first matching directory entry structure. */
   if(ODDirDOSFindFirst(pszPath, &pDirInfo->FindBlock, wAttributes))
   {
      /* If unable to read directory entry, release directory information   */
      /* structure, and return indicating that there are no matching files. */
      free(pDirInfo);
      return(kODRCNoMatch);
   }
#endif /* ODPLAT_DOS */

#ifdef ODPLAT_WIN32
   /* Store a copy of the attributes passed to open function. */
   pDirInfo->wAttributes = wAttributes;

   /* Attempt to read first directory entry. */
   pDirInfo->hWindowsDir = FindFirstFile(pszPath, &pDirInfo->WindowsDirEntry);

   if(pDirInfo->hWindowsDir == INVALID_HANDLE_VALUE)
   {
      /* If unable to read directory entry, release directory information   */
      /* structure, and return indicating that there are no matching files. */
      free(pDirInfo);
      return(kODRCNoMatch);
   }

   /* If first file doesn't match specified attributes, then find one that */
   /* does.                                                                */
   /* Find next matching entry, if any. */
   while(!ODDirWinMatchesAttributes(pDirInfo))
   {
      if(!FindNextFile(pDirInfo->hWindowsDir, &pDirInfo->WindowsDirEntry))
      {
         /* If unable to find matching directory entry, then release       */
         /* structure, return indicating that there are no matching files. */
         free(pDirInfo);
         return(kODRCNoMatch);
      }
   }
#endif /* ODPLAT_WIN32 */

deuce's avatar
deuce committed
933 934 935
#ifdef ODPLAT_NIX
   if(glob(pszPath,GLOB_NOSORT,NULL,&(pDirInfo->g)))
      return(kODRCNoMatch);
936
   if(pDirInfo->g.gl_pathc==0)  {
deuce's avatar
deuce committed
937 938 939 940 941 942 943
      globfree(&(pDirInfo->g));
      return(kODRCNoMatch);
   }
   pDirInfo->pos=0;
   pDirInfo->wAttributes = wAttributes;
#endif

rswindell's avatar
rswindell committed
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
   /* Now that open operation is complete, give the caller a directory */
   /* handle. */
   *phDir = ODPTR2HANDLE(pDirInfo, tODDirInfo);

   /* Return with success. */
   return(kODRCSuccess);
}


/* ----------------------------------------------------------------------------
 * ODDirRead()
 *
 * Reads the next directory entry from an open directory, placing the directory
 * information into the tODDirEntry structure pointed to by pDirEntry.
 *
 * Parameters: hDir      - Handle to an open directory, as provided by
 *                         ODDirOpen().
 *
 *             pDirEntry - Pointer to structure into which directory entry
 *                         information should be placed.
 *
 *     Return: A tODResult indicating success or reason for failure. After the
 *             last directory entry has been read, all subsequent calls to
 *             ODDirRead() will return kODRCEndOfFile.
 */
tODResult ODDirRead(tODDirHandle hDir, tODDirEntry *pDirEntry)
{
   tODDirInfo *pDirInfo = ODHANDLE2PTR(hDir, tODDirInfo);
#ifdef ODPLAT_WIN32
   WORD wDOSDate;
   WORD wDOSTime;
#endif /* ODPLAT_WIN32 */
deuce's avatar
deuce committed
976 977 978
#ifdef ODPLAT_NIX
   struct stat st;
#endif
rswindell's avatar
rswindell committed
979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
   
   ASSERT(pDirEntry != NULL);
   ASSERT(pDirInfo != NULL);

   /* Check whether the last directory entry has been returned yet. */
   if(pDirInfo->bEOF)
   {
      /* Return this state information to the caller. */
      return(kODRCEndOfFile);
   }

#ifdef ODPLAT_DOS
   /* Provide the caller with the information from the previously read */
   /* directory entry.                                                 */

   /* Copy the filename to the caller's structure. */
   ODStringCopy(pDirEntry->szFileName, pDirInfo->FindBlock.szFileName,
      DIR_FILENAME_SIZE);

   /* Copy the attributes to the caller's structure. */
   pDirEntry->wAttributes = pDirInfo->FindBlock.btAttrib;

   /* Copy the file size to the caller's structure. */
   pDirEntry->dwFileSize = pDirInfo->FindBlock.dwFileSize;

   /* Determine the last file write time, in C library time format. */
   pDirEntry->LastWriteTime = DOSToCTime(pDirInfo->FindBlock.wFileDate,
      pDirInfo->FindBlock.wFileTime);

   /* Read next directory entry, if any. */
   pDirInfo->bEOF = ODDirDOSFindNext(&pDirInfo->FindBlock);

#endif /* ODPLAT_DOS */

#ifdef ODPLAT_WIN32
   /* Provide the caller with the information from the previously read */
   /* directory entry.                                                 */

   /* Copy filename from Win32 8.3 filename. */
   if(strlen(pDirInfo->WindowsDirEntry.cAlternateFileName) == 0)
   {
      ODStringCopy(pDirEntry->szFileName,
         pDirInfo->WindowsDirEntry.cFileName, DIR_FILENAME_SIZE);
   }
   else
   {
      ODStringCopy(pDirEntry->szFileName,
         pDirInfo->WindowsDirEntry.cAlternateFileName, DIR_FILENAME_SIZE);
   }

   /* Copy attribute bits. */
   pDirEntry->wAttributes = DIR_ATTRIB_NORMAL;
   if(pDirInfo->WindowsDirEntry.dwFileAttributes & FILE_ATTRIBUTE_ARCHIVE)
   {
      pDirEntry->wAttributes |= DIR_ATTRIB_ARCH;
   }
   if(pDirInfo->WindowsDirEntry.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
   {
      pDirEntry->wAttributes |= DIR_ATTRIB_DIREC;
   }
   if(pDirInfo->WindowsDirEntry.dwFileAttributes & FILE_ATTRIBUTE_HIDDEN)
   {
      pDirEntry->wAttributes |= DIR_ATTRIB_HIDDEN;
   }
   if(pDirInfo->WindowsDirEntry.dwFileAttributes & FILE_ATTRIBUTE_READONLY)
   {
      pDirEntry->wAttributes |= DIR_ATTRIB_RDONLY;
   }
   if(pDirInfo->WindowsDirEntry.dwFileAttributes & FILE_ATTRIBUTE_SYSTEM)
   {
      pDirEntry->wAttributes |= DIR_ATTRIB_SYSTEM;
   }

   /* Copy the file size to the caller's structure. */
   pDirEntry->dwFileSize = (long)pDirInfo->WindowsDirEntry.nFileSizeLow;

   /* Determine the last file write time, in C library time format. */
   FileTimeToDosDateTime(&pDirInfo->WindowsDirEntry.ftLastWriteTime, &wDOSDate,
      &wDOSTime);
   pDirEntry->LastWriteTime = DOSToCTime(wDOSDate, wDOSTime);

   /* Find next matching entry, if any. */
   do
   {
      if(!FindNextFile(pDirInfo->hWindowsDir, &pDirInfo->WindowsDirEntry))
      {
         pDirInfo->bEOF = TRUE;
      }
   } while(!ODDirWinMatchesAttributes(pDirInfo));
#endif /* ODPLAT_WIN32 */

deuce's avatar
deuce committed
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
#ifdef ODPLAT_NIX
   while(!pDirInfo->bEOF)  {
      if(strrchr(pDirInfo->g.gl_pathv[pDirInfo->pos],DIRSEP)==NULL)
	     strcpy(pDirEntry->szFileName,pDirInfo->g.gl_pathv[pDirInfo->pos]);
	  else
	     strcpy(pDirEntry->szFileName,strrchr(pDirInfo->g.gl_pathv[pDirInfo->pos],DIRSEP));
	  stat(pDirInfo->g.gl_pathv[pDirInfo->pos],&st);
	  pDirEntry->wAttributes=DIR_ATTRIB_NORMAL;
	  if(st.st_mode & S_IFDIR)
	  	 pDirEntry->wAttributes |= DIR_ATTRIB_DIREC;
	  if(!st.st_mode & S_IWUSR)
	  	 pDirEntry->wAttributes |= DIR_ATTRIB_RDONLY;
	  if(!st.st_mode & S_IRUSR)
	  	 pDirEntry->wAttributes |= DIR_ATTRIB_SYSTEM;
deuce's avatar
deuce committed
1084 1085
	  pDirEntry->LastWriteTime=st.st_mtime;
	  pDirEntry->dwFileSize=st.st_size;
deuce's avatar
deuce committed
1086
	  pDirInfo->pos++;
1087
	  if(pDirInfo->pos==pDirInfo->g.gl_pathc)
deuce's avatar
deuce committed
1088 1089 1090 1091 1092 1093 1094 1095
	     pDirInfo->bEOF=TRUE;
	  if(pDirEntry->wAttributes==pDirInfo->wAttributes)
	     return(kODRCSuccess);
	  if(pDirInfo->bEOF==TRUE)
	    return(kODRCEndOfFile);
   }
#endif

rswindell's avatar
rswindell committed
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
   /* Return with success. */
   return(kODRCSuccess);
}


/* ----------------------------------------------------------------------------
 * ODDirClose()
 *
 * Closes and open directory handle.
 *
 * Parameters: hDir - Handle to an open directory handle, as provided by the
 *                    ODDirOpen() function.
 *
 *     Return: void
 */
void ODDirClose(tODDirHandle hDir)
{
   tODDirInfo *pDirInfo = ODHANDLE2PTR(hDir, tODDirInfo);

   ASSERT(pDirInfo != NULL);

#ifdef ODPLAT_WIN32
   /* Under Win32, close directory handle. */
   FindClose(pDirInfo->hWindowsDir);
#endif /* ODPLAT_WIN32 */

deuce's avatar
deuce committed
1122 1123 1124 1125
#ifdef ODPLAT_NIX
   globfree(&(pDirInfo->g));
#endif

rswindell's avatar
rswindell committed
1126 1127 1128 1129 1130
   /* Free the directory information structure. */
   free(pDirInfo);
}


1131
#if defined(ODPLAT_DOS) || defined(ODPLAT_WIN32)
rswindell's avatar
rswindell committed
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
/* ----------------------------------------------------------------------------
 * DOSToCTime()                                        *** PRIVATE FUNCTION ***
 *
 * Converts DOS directory entry time format to the C library time format.
 *
 * Parameters: uDate - Date portion of the time to be converted.
 *
 *             uTime - Time of day portion of the time to be converted.
 *
 *     Return: The specified time, represented as a time_t.
 */
static time_t DOSToCTime(WORD wDate, WORD wTime)
{
   struct tm TimeStruct;

   TimeStruct.tm_sec = (wTime & 0x001f) * 2;
   TimeStruct.tm_min = (wTime & 0x07e0) >> 5;
   TimeStruct.tm_hour = (wTime & 0xf800) >> 11;
   TimeStruct.tm_mday = wDate & 0x001f;
   TimeStruct.tm_mon = ((wDate & 0x01e0) >> 5) - 1;
   TimeStruct.tm_year = 80 + ((wDate & 0xfe00) >> 9);

   return(mktime(&TimeStruct));
}
1156
#endif
rswindell's avatar
rswindell committed
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344


/* MS-DOS specific functions for directory access. */
#ifdef ODPLAT_DOS

/* ----------------------------------------------------------------------------
 * ODDirDOSFindFirst()                                 *** PRIVATE FUNCTION ***
 *
 * MS-DOS specific "Find First" function for reading directory entries. This
 * is essentially just a C-language interface to the interrupt function call
 * that is provided by DOS.
 *
 * Parameters: pszPath     - Pointer to string containing directory and
 *                           filespec to search for.
 *
 *             pBlock      - Pointer to directory block.
 *
 *             nAttributes - Attributes to match, if any.
 *
 *     Return: 0 on success, -1 on failure.
 */
static int ODDirDOSFindFirst(CONST char *pszPath, tDOSDirEntry *pBlock,
   WORD wAttributes)
{
   int nToReturn;

   ASSERT(pszPath != NULL);
   ASSERT(pBlock != NULL);

   ASM     push ds
   ASM     mov ah, 0x2f            /* Int 0x21, ah=0x2f: Get current DOS DTA */
   ASM     int 0x21                                       /* Get current DTA */
   ASM     push bx                   /* Store offset of current DTA on stack */
   ASM     push es                  /* Store segment of current DTA on stack */
   ASM     mov ah, 0x1a                /* Int 0x21, ah=0x1a: Set new DOS DTA */
#ifdef LARGEDATA                                    /* If using far pointers */
   ASM     lds dx, pBlock           /* Load DS:DX with far address of pBlock */
#else                                              /* If using near pointers */
   ASM     mov dx, pBlock             /* Load DX with near address of pBlock */
#endif
   ASM     int 0x21                                           /* Set DOS DTA */
   ASM     mov ah, 0x4e         /* Int 0x21, ah=0x4e: DOS findfirst function */
   ASM     mov cx, wAttributes                    /* Load attributes into CX */
#ifdef LARGEDATA                                    /* If using far pointers */
   ASM     lds dx, pszPath         /* Load DS:DX with far address in pszPath */
#else                                              /* If using near pointers */
   ASM     mov dx, pszPath           /* Load DX with near address in pszPath */
#endif
   ASM     int 0x21                               /* Call findfirst function */
   ASM     jc error       /* If carry flag is set, then an error has ocurred */
   ASM     mov word ptr nToReturn, 0                /* If no error, return 0 */
   ASM     jmp after_result
error:
   ASM     mov word ptr nToReturn, -1                 /* If error, return -1 */
after_result:
   ASM     mov ah, 0x1a                /* Int 0x21, ah=0x1a: Set new DOS DTA */
   ASM     pop ds                   /* Pop original DTA segment off of stack */
   ASM     pop dx                      /* Pop original DTA offest from stack */
   ASM     int 0x21                             /* Reset DOS DTA to original */
   ASM     pop ds                   /* Restore DS stored at function startup */
   return(nToReturn);
}


/* ----------------------------------------------------------------------------
 * ODDirDOSFindNext()                                  *** PRIVATE FUNCTION ***
 *
 * MS-DOS specific "Find Next" function for reading directory entries. This
 * is essentially just a C-language interface to the interrupt function call
 * that is provided by DOS.
 *
 * Parameters: pBlock - Pointer to block in which to store next directory
 *                      entry.
 *
 *     Return: 0 on success, -1 on failure.
 */
static int ODDirDOSFindNext(tDOSDirEntry *pBlock)
{
   int nToReturn;

   ASSERT(pBlock != NULL);

   ASM     push ds                                                /* Save DS */
   ASM     mov ah, 0x2f            /* Int 0x21, ah=0x2f: Get current DOS DTA */
   ASM     int 0x21                                       /* Get current DTA */
   ASM     push bx                   /* Store offset of current DTA on stack */
   ASM     push es                  /* Store segment of current DTA on stack */
   ASM     mov ah, 0x1a                /* Int 0x21, ah=0x1a: Set new DOS DTA */
#ifdef LARGEDATA                                    /* If using far pointers */
   ASM     lds dx, pBlock           /* Load DS:DX with far address of pBlock */
#else                                              /* If using near pointers */
   ASM     mov dx, pBlock             /* Load DX with near address of pBlock */
#endif
   ASM     int 0x21                                           /* Set DOS DTA */
   ASM     mov ah, 0x4f          /* Int 0x21, ah=0x4f: DOS findnext function */
   ASM     int 0x21                               /* Call findfirst function */
   ASM     jc error       /* If carry flag is set, then an error has ocurred */
   ASM     mov word ptr nToReturn, 0                /* If no error, return 0 */
   ASM     jmp after_result
error:
   ASM     mov word ptr nToReturn, -1                 /* If error, return -1 */
after_result:
   ASM     mov ah, 0x1a                /* Int 0x21, ah=0x1a: Set new DOS DTA */
   ASM     pop ds                   /* Pop original DTA segment off of stack */
   ASM     pop dx                      /* Pop original DTA offest from stack */
   ASM     int 0x21                             /* Reset DOS DTA to original */
   ASM     pop ds                   /* Restore DS stored at function startup */
   return(nToReturn);
}

#endif /* ODPLAT_DOS */


/* Win32 specific private functions for directory access. */
#ifdef ODPLAT_WIN32
/* ----------------------------------------------------------------------------
 * ODDirWinMatchesAttributes()                         *** PRIVATE FUNCTION ***
 *
 * Determines whether or not the directory entry pDirInfo->WindowsDirEntry
 * meets the attribute requirements specified in pDirInfo->nAttributes
 *
 * Parameters: pDirInfo - Pointer to a directory information structure with
 *                        attribute and directory entry values.
 *
 *     Return: TRUE if the file matches the attributes, FALSE if it does not.
 */
static BOOL ODDirWinMatchesAttributes(tODDirInfo *pDirInfo)
{
   if((pDirInfo->WindowsDirEntry.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
      && !(pDirInfo->wAttributes & DIR_ATTRIB_DIREC))
   {
      return(FALSE);
   }

   if((pDirInfo->WindowsDirEntry.dwFileAttributes & FILE_ATTRIBUTE_ARCHIVE)
      && !(pDirInfo->wAttributes & DIR_ATTRIB_ARCH))
   {
      return(FALSE);
   }

   if((pDirInfo->WindowsDirEntry.dwFileAttributes & FILE_ATTRIBUTE_HIDDEN)
      && !(pDirInfo->wAttributes & DIR_ATTRIB_HIDDEN))
   {
      return(FALSE);
   }

   if((pDirInfo->WindowsDirEntry.dwFileAttributes & FILE_ATTRIBUTE_READONLY)
      && !(pDirInfo->wAttributes & DIR_ATTRIB_RDONLY))
   {
      return(FALSE);
   }

   if((pDirInfo->WindowsDirEntry.dwFileAttributes & FILE_ATTRIBUTE_SYSTEM)
      && !(pDirInfo->wAttributes & DIR_ATTRIB_SYSTEM))
   {
      return(FALSE);
   }

   return(TRUE);
}
#endif /* ODPLAT_WIN32 */


/* ----------------------------------------------------------------------------
 * ODDirChangeCurrent()
 *
 * Changes current directory to the one specified.
 *
 * Parameters: pszPath - String containing path to change to.
 *
 *     Return: void
 */
void ODDirChangeCurrent(char *pszPath)
{
#ifdef ODPLAT_DOS
   int nDrive = 0;

   if(pszPath[1] == ':')
   {
      nDrive = (toupper(pszPath[0]) - 'A');
   }

   _setdrvcd(nDrive, (char *)pszPath);
#endif /* ODPLAT_DOS */

#ifdef ODPLAT_WIN32
   SetCurrentDirectory(pszPath);
#endif /* ODPLAT_WIN32 */
deuce's avatar
deuce committed
1345 1346 1347 1348

#ifdef ODPLAT_NIX
   chdir(pszPath);
#endif
rswindell's avatar
rswindell committed
1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381
}


/* ----------------------------------------------------------------------------
 * ODDirGetCurrent()
 *
 * Obtains the name of the  current directory, including the current drive
 * designator.
 *
 * Parameters: pszPath       - String containing path to change to.
 *
 *             nMaxPathChars - Maximum characters in the buffer pointer to by
 *                             pszPath.
 *
 *     Return: void
 */
void ODDirGetCurrent(char *pszPath, INT nMaxPathChars)
{
   ASSERT(pszPath != NULL);
   ASSERT(nMaxPathChars > 0);

#ifdef ODPLAT_DOS
   UNUSED(nMaxPathChars);

   strcpy(pszPath, "X:\\");
   pszPath[0] = 'A' + _getdrv();
   _getcd(0, (char *)pszPath + 3);
#endif /* ODPLAT_DOS */

#ifdef ODPLAT_WIN32
   GetCurrentDirectory(nMaxPathChars, pszPath);
#endif /* ODPLAT_WIN32 */

deuce's avatar
deuce committed
1382 1383 1384 1385
#ifdef ODPLAT_NIX
   getcwd(pszPath,nMaxPathChars);
#endif

rswindell's avatar
rswindell committed
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433
   ASSERT((INT)strlen(pszPath) + 1 <= nMaxPathChars);
}


/* ========================================================================= */
/* Misc. Functions                                                           */
/* ========================================================================= */

/* ----------------------------------------------------------------------------
 * ODFileDelete()
 *
 * Deletes the file with the specified filename.
 *
 * Parameters: pszPath - Filename, possibly with path, to delete.
 *
 *     Return: kODRCSuccess on success, or an error code on failure.
 */
tODResult ODFileDelete(CONST char *pszPath)
{
#ifdef ODPLAT_DOS
   {
      tODResult Result;

      ASM    push ds
#ifdef LARGEDATA
      ASM    lds dx, pszPath
#else /* !LARGEDATA */
      ASM    mov ax, ss
      ASM    mov ds, ax
      ASM    mov dx, pszPath
#endif /* !LARGEDATA */
      ASM    mov ah, 0x41
      ASM    int 0x21
      ASM    jc Failure
      ASM    mov word ptr Result, kODRCSuccess
      ASM    jmp Done
Failure:
      ASM    mov word ptr Result, kODRCGeneralFailure
Done:
      ASM    pop ds

      return(Result);
   }
#endif /* ODPLAT_DOS */

#ifdef ODPLAT_WIN32
   return(DeleteFile(pszPath) ? kODRCSuccess : kODRCGeneralFailure);
#endif /* ODPLAT_WIN32 */
deuce's avatar
deuce committed
1434 1435 1436 1437

#ifdef ODPLAT_NIX
   return(unlink(pszPath));
#endif
rswindell's avatar
rswindell committed
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465
}


/* ----------------------------------------------------------------------------
 * ODFileAccessMode()
 *
 * Determines the access permissions of a file.
 *
 * Parameters: pszFilename - Name of file to test.
 *
 *             nAccessMode - Indicates which file access mode to test for.
 *                           A value of 0 indicates existance, 2 indicates
 *                           write permission, 4 indicates read permission,
 *                           and 6 indicates read/write permission.
 *
 *     Return: FALSE if file can be accessed or TRUE if file cannot be
 *             accessed.
 */
BOOL ODFileAccessMode(char *pszFilename, int nAccessMode)
{
   FILE *pfFileToTest;
   char *pszModeString;
   tODDirHandle hDir;

#ifdef ODPLAT_DOS
   BYTE nLength;
   /* If we are looking for the root directory. */
   nLength = strlen(pszFilename);
deuce's avatar
deuce committed
1466 1467
   if((nLength == 3 && pszFilename[1] == ':' && pszFilename[2] == DIRSEP) ||
      (nLength == 1 && pszFilename[0] == DIRSEP))
rswindell's avatar
rswindell committed
1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530
   {
      if(nAccessMode == 0)
      {
          int to_return = FALSE;

#ifdef LARGEDATA
         ASM push ds
         ASM lds dx, pszFilename
#else
         ASM mov dx, pszFilename
#endif
         ASM mov ax, 0x4300
         ASM int 0x21
         ASM jnc done
         ASM mov word ptr to_return, TRUE
done:
#ifdef LARGEDATA
         ASM pop ds
#endif
          return(to_return);
      }
      else
      {
          return(TRUE);
      }
   }
#endif /* ODPLAT_DOS */

   /* If the file doesn't exit, we fail in any mode. */
   if(ODDirOpen(pszFilename,
      DIR_ATTRIB_ARCH | DIR_ATTRIB_RDONLY | DIR_ATTRIB_DIREC,
      &hDir) != kODRCSuccess)
   {
      return(TRUE);
   }

   /* If directory open succeeded, then close it again. */
   ODDirClose(hDir);

   /* If the file does exist, then amode 0 is satisfied. */
   if(nAccessMode == 0) return(FALSE);

   /* If testing for an access permission, determine corresponding fopen() */
   /* mode.                                                                */
   switch(nAccessMode)
   {
      case 2:
        pszModeString = "a";
        break;
      case 4:
        pszModeString = "r";
        break;
      default:
         pszModeString = "r+";
   }

   /* Attempt to open the file, if unable to do so return failure. */
   if((pfFileToTest=fopen(pszFilename,pszModeString)) == NULL) return(TRUE);

   /* If file open was successful, close it again, and return success. */
   fclose(pfFileToTest);
   return(FALSE);
}