Logo Search packages:      
Sourcecode: scummvm version File versions

util.cpp

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program 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; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * $URL: https://scummvm.svn.sourceforge.net/svnroot/scummvm/scummvm/tags/release-0-13-0/common/util.cpp $
 * $Id: util.cpp 35074 2008-11-15 03:34:08Z lordhoto $
 */

#include "engines/engine.h"
#include "common/util.h"
#include "common/system.h"
#include "gui/debugger.h"

#ifdef _WIN32_WCE
// This is required for the debugger attachment
extern bool isSmartphone(void);
#endif

#ifdef __PLAYSTATION2__
      // for those replaced fopen/fread/etc functions
      typedef unsigned long   uint64;
      typedef signed long     int64;
      #include "backends/platform/ps2/fileio.h"

      #define fprintf                     ps2_fprintf
      #define fflush(a)             ps2_fflush(a)
#endif

#ifdef __DS__
      #include "backends/fs/ds/ds-fs.h"

      #undef stderr
      #undef stdout
      #undef stdin

      #define stdout ((DS::fileHandle*) -1)
      #define stderr ((DS::fileHandle*) -2)
      #define stdin ((DS::fileHandle*) -3)

      void  std_fprintf(FILE* handle, const char* fmt, ...);
      void  std_fflush(FILE* handle);

      #define fprintf(file, fmt, ...)                       { char str[128]; sprintf(str, fmt, ##__VA_ARGS__); DS::std_fwrite(str, strlen(str), 1, file); }
      #define fflush(file)                                  DS::std_fflush(file)
#endif


namespace Common {

00066 StringTokenizer::StringTokenizer(const String &str, const String &delimiters) : _str(str), _delimiters(delimiters) {
      reset();
}

00070 void StringTokenizer::reset() {
      _tokenBegin = _tokenEnd = 0;
}

00074 bool StringTokenizer::empty() const {
      // Search for the next token's start (i.e. the next non-delimiter character)
      for (uint i = _tokenEnd; i < _str.size(); i++) {
            if (!_delimiters.contains(_str[i]))
                  return false; // Found a token so the tokenizer is not empty
      }
      // Didn't find any more tokens so the tokenizer is empty
      return true;
}

00084 String StringTokenizer::nextToken() {
      // Seek to next token's start (i.e. jump over the delimiters before next token)
      for (_tokenBegin = _tokenEnd; _tokenBegin < _str.size() && _delimiters.contains(_str[_tokenBegin]); _tokenBegin++);
      // Seek to the token's end (i.e. jump over the non-delimiters)
      for (_tokenEnd = _tokenBegin; _tokenEnd < _str.size() && !_delimiters.contains(_str[_tokenEnd]); _tokenEnd++);
      // Return the found token
      return String(_str.c_str() + _tokenBegin, _tokenEnd - _tokenBegin);
}

//
// Print hexdump of the data passed in
//
void hexdump(const byte * data, int len, int bytesPerLine) {
      assert(1 <= bytesPerLine && bytesPerLine <= 32);
      int i;
      byte c;
      int offset = 0;
      while (len >= bytesPerLine) {
            printf("%06x: ", offset);
            for (i = 0; i < bytesPerLine; i++) {
                  printf("%02x ", data[i]);
                  if (i % 4 == 3)
                        printf(" ");
            }
            printf(" |");
            for (i = 0; i < bytesPerLine; i++) {
                  c = data[i];
                  if (c < 32 || c >= 127)
                        c = '.';
                  printf("%c", c);
            }
            printf("|\n");
            data += bytesPerLine;
            len -= bytesPerLine;
            offset += bytesPerLine;
      }

      if (len <= 0)
            return;

      printf("%06x: ", offset);
      for (i = 0; i < bytesPerLine; i++) {
            if (i < len)
                  printf("%02x ", data[i]);
            else
                  printf("   ");
            if (i % 4 == 3)
                  printf(" ");
      }
      printf(" |");
      for (i = 0; i < len; i++) {
            c = data[i];
            if (c < 32 || c >= 127)
                  c = '.';
            printf("%c", c);
      }
      for (; i < bytesPerLine; i++)
            printf(" ");
      printf("|\n");
}

#pragma mark -


RandomSource::RandomSource() {
      // Use system time as RNG seed. Normally not a good idea, if you are using
      // a RNG for security purposes, but good enough for our purposes.
      assert(g_system);
      uint32 seed = g_system->getMillis();
      setSeed(seed);
}

void RandomSource::setSeed(uint32 seed) {
      _randSeed = seed;
}

00160 uint RandomSource::getRandomNumber(uint max) {
      _randSeed = 0xDEADBF03 * (_randSeed + 1);
      _randSeed = (_randSeed >> 13) | (_randSeed << 19);
      return _randSeed % (max + 1);
}

00166 uint RandomSource::getRandomBit(void) {
      _randSeed = 0xDEADBF03 * (_randSeed + 1);
      _randSeed = (_randSeed >> 13) | (_randSeed << 19);
      return _randSeed & 1;
}

00172 uint RandomSource::getRandomNumberRng(uint min, uint max) {
      return getRandomNumber(max - min) + min;
}


#pragma mark -


const LanguageDescription g_languages[] = {
      {"zh", "Chinese (Taiwan)", ZH_TWN},
      {"cz", "Czech", CZ_CZE},
      {"nl", "Dutch", NL_NLD},
      {"en", "English", EN_ANY}, // Generic English (when only one game version exist)
      {"gb", "English (GB)", EN_GRB},
      {"us", "English (US)", EN_USA},
      {"fr", "French", FR_FRA},
      {"de", "German", DE_DEU},
      {"gr", "Greek", GR_GRE},
      {"hb", "Hebrew", HB_ISR},
      {"it", "Italian", IT_ITA},
      {"jp", "Japanese", JA_JPN},
      {"kr", "Korean", KO_KOR},
      {"nb", "Norwegian Bokm\xE5l", NB_NOR},
      {"pl", "Polish", PL_POL},
      {"br", "Portuguese", PT_BRA},
      {"ru", "Russian", RU_RUS},
      {"es", "Spanish", ES_ESP},
      {"se", "Swedish", SE_SWE},
      {0, 0, UNK_LANG}
};

Language parseLanguage(const String &str) {
      if (str.empty())
            return UNK_LANG;

      const LanguageDescription *l = g_languages;
      for (; l->code; ++l) {
            if (str.equalsIgnoreCase(l->code))
                  return l->id;
      }

      return UNK_LANG;
}

const char *getLanguageCode(Language id) {
      const LanguageDescription *l = g_languages;
      for (; l->code; ++l) {
            if (l->id == id)
                  return l->code;
      }
      return 0;
}

const char *getLanguageDescription(Language id) {
      const LanguageDescription *l = g_languages;
      for (; l->code; ++l) {
            if (l->id == id)
                  return l->description;
      }
      return 0;
}


#pragma mark -


const PlatformDescription g_platforms[] = {
      {"2gs", "2gs", "2gs", "Apple IIgs", kPlatformApple2GS },
      {"3do", "3do", "3do", "3DO", kPlatform3DO},
      {"acorn", "acorn", "acorn", "Acorn", kPlatformAcorn},
      {"amiga", "ami", "amiga", "Amiga", kPlatformAmiga},
      {"atari", "atari-st", "st", "Atari ST", kPlatformAtariST},
      {"c64", "c64", "c64", "Commodore 64", kPlatformC64},
      {"pc", "dos", "ibm", "DOS", kPlatformPC},
      {"pc98", "pc98", "pc98", "PC-98", kPlatformPC98},
      {"wii", "wii", "wii", "Nintendo Wii", kPlatformWii},

      // The 'official' spelling seems to be "FM-TOWNS" (e.g. in the Indy4 demo).
      // However, on the net many variations can be seen, like "FMTOWNS",
      // "FM TOWNS", "FmTowns", etc.
      {"fmtowns", "towns", "fm", "FM-TOWNS", kPlatformFMTowns},

      {"linux", "linux", "linux", "Linux", kPlatformLinux},
      {"macintosh", "mac", "mac", "Macintosh", kPlatformMacintosh},
      {"pce", "pce", "pce", "PC-Engine", kPlatformPCEngine },
      {"nes", "nes", "nes", "NES", kPlatformNES},
      {"segacd", "segacd", "sega", "SegaCD", kPlatformSegaCD},
      {"windows", "win", "win", "Windows", kPlatformWindows},


      {0, 0, 0, "Default", kPlatformUnknown}
};

Platform parsePlatform(const String &str) {
      if (str.empty())
            return kPlatformUnknown;

      // Handle some special case separately, for compatibility with old config
      // files.
      if (str == "1")
            return kPlatformAmiga;
      else if (str == "2")
            return kPlatformAtariST;
      else if (str == "3")
            return kPlatformMacintosh;

      const PlatformDescription *l = g_platforms;
      for (; l->code; ++l) {
            if (str.equalsIgnoreCase(l->code) || str.equalsIgnoreCase(l->code2) || str.equalsIgnoreCase(l->abbrev))
                  return l->id;
      }

      return kPlatformUnknown;
}


const char *getPlatformCode(Platform id) {
      const PlatformDescription *l = g_platforms;
      for (; l->code; ++l) {
            if (l->id == id)
                  return l->code;
      }
      return 0;
}

const char *getPlatformAbbrev(Platform id) {
      const PlatformDescription *l = g_platforms;
      for (; l->code; ++l) {
            if (l->id == id)
                  return l->abbrev;
      }
      return 0;
}

const char *getPlatformDescription(Platform id) {
      const PlatformDescription *l = g_platforms;
      for (; l->code; ++l) {
            if (l->id == id)
                  return l->description;
      }
      return l->description;
}


#pragma mark -


const RenderModeDescription g_renderModes[] = {
      {"hercGreen", "Hercules Green", kRenderHercG},
      {"hercAmber", "Hercules Amber", kRenderHercA},
      {"cga", "CGA", kRenderCGA},
      {"ega", "EGA", kRenderEGA},
      {"amiga", "Amiga", kRenderAmiga},
      {0, 0, kRenderDefault}
};

RenderMode parseRenderMode(const String &str) {
      if (str.empty())
            return kRenderDefault;

      const RenderModeDescription *l = g_renderModes;
      for (; l->code; ++l) {
            if (str.equalsIgnoreCase(l->code))
                  return l->id;
      }

      return kRenderDefault;
}

const char *getRenderModeCode(RenderMode id) {
      const RenderModeDescription *l = g_renderModes;
      for (; l->code; ++l) {
            if (l->id == id)
                  return l->code;
      }
      return 0;
}

const char *getRenderModeDescription(RenderMode id) {
      const RenderModeDescription *l = g_renderModes;
      for (; l->code; ++l) {
            if (l->id == id)
                  return l->description;
      }
      return 0;
}

#pragma mark -

namespace {

DebugLevelContainer gDebugLevels;
uint32 gDebugLevelsEnabled = 0;

struct DebugLevelSort {
      bool operator()(const EngineDebugLevel &l, const EngineDebugLevel &r) {
            return (l.option.compareToIgnoreCase(r.option) < 0);
      }
};

struct DebugLevelSearch {
      const String &_option;

      DebugLevelSearch(const String &option) : _option(option) {}

      bool operator()(const EngineDebugLevel &l) {
            return _option.equalsIgnoreCase(l.option);
      }
};

}

bool addSpecialDebugLevel(uint32 level, const String &option, const String &description) {
      DebugLevelContainer::iterator i = find_if(gDebugLevels.begin(), gDebugLevels.end(), DebugLevelSearch(option));

      if (i != gDebugLevels.end()) {
            warning("Declared engine debug level '%s' again", option.c_str());
            *i = EngineDebugLevel(level, option, description);
      } else {
            gDebugLevels.push_back(EngineDebugLevel(level, option, description));
            sort(gDebugLevels.begin(), gDebugLevels.end(), DebugLevelSort());
      }

      return true;
}

void clearAllSpecialDebugLevels() {
      gDebugLevelsEnabled = 0;
      gDebugLevels.clear();
}

bool enableSpecialDebugLevel(const String &option) {
      DebugLevelContainer::iterator i = find_if(gDebugLevels.begin(), gDebugLevels.end(), DebugLevelSearch(option));

      if (i != gDebugLevels.end()) {
            gDebugLevelsEnabled |= i->level;
            i->enabled = true;

            return true;
      } else {
            return false;
      }
}

void enableSpecialDebugLevelList(const String &option) {
      StringTokenizer tokenizer(option, " ,");
      String token;

      while (!tokenizer.empty()) {
            token = tokenizer.nextToken();
            if (!enableSpecialDebugLevel(token))
                  warning("Engine does not support debug level '%s'", token.c_str());
      }
}

bool disableSpecialDebugLevel(const String &option) {
      DebugLevelContainer::iterator i = find_if(gDebugLevels.begin(), gDebugLevels.end(), DebugLevelSearch(option));

      if (i != gDebugLevels.end()) {
            gDebugLevelsEnabled &= ~i->level;
            i->enabled = false;

            return true;
      } else {
            return false;
      }
}

const DebugLevelContainer &listSpecialDebugLevels() {
      return gDebugLevels;
}

uint32 getEnabledSpecialDebugLevels() {
      return gDebugLevelsEnabled;
}


}     // End of namespace Common



/**
 * The debug level. Initially set to -1, indicating that no debug output
 * should be shown. Positive values usually imply an increasing number of
 * debug output shall be generated, the higher the value, the more verbose the
 * information (although the exact semantics are up to the engines).
 */
int gDebugLevel = -1;

#ifndef DISABLE_TEXT_CONSOLE

static void debugHelper(const char *in_buf, bool caret = true) {
      char buf[STRINGBUFLEN];

      // Next, give the active engine (if any) a chance to augment the message
      if (g_engine) {
            g_engine->errorString(in_buf, buf, STRINGBUFLEN);
      } else {
            strncpy(buf, in_buf, STRINGBUFLEN);
            buf[STRINGBUFLEN-1] = '\0';
      }

      if (caret)
            printf("%s\n", buf);
      else
            printf("%s", buf);

#if defined( USE_WINDBG )
      if (caret)
            strcat(buf, "\n");
#if defined( _WIN32_WCE )
      TCHAR buf_unicode[1024];
      MultiByteToWideChar(CP_ACP, 0, buf, strlen(buf) + 1, buf_unicode, sizeof(buf_unicode));
      OutputDebugString(buf_unicode);
#else
      OutputDebugString(buf);
#endif
#endif

      fflush(stdout);
}

void debug(int level, const char *s, ...) {
      char buf[STRINGBUFLEN];
      va_list va;

      if (level > gDebugLevel)
            return;

      va_start(va, s);
      vsnprintf(buf, STRINGBUFLEN, s, va);
      va_end(va);

      debugHelper(buf);
}

void debugN(int level, const char *s, ...) {
      char buf[STRINGBUFLEN];
      va_list va;

      if (level > gDebugLevel)
            return;

      va_start(va, s);
      vsnprintf(buf, STRINGBUFLEN, s, va);
      va_end(va);

      debugHelper(buf, false);
}

void debug(const char *s, ...) {
      char buf[STRINGBUFLEN];
      va_list va;

      va_start(va, s);
      vsnprintf(buf, STRINGBUFLEN, s, va);
      va_end(va);

      debugHelper(buf);
}

void debugC(int level, uint32 engine_level, const char *s, ...) {
      char buf[STRINGBUFLEN];
      va_list va;

      if (gDebugLevel != 11)
            if (level > gDebugLevel || !(Common::gDebugLevelsEnabled & engine_level))
                  return;

      va_start(va, s);
      vsnprintf(buf, STRINGBUFLEN, s, va);
      va_end(va);

      debugHelper(buf);
}

void warning(const char *s, ...) {
      char buf[STRINGBUFLEN];
      va_list va;

      va_start(va, s);
      vsnprintf(buf, STRINGBUFLEN, s, va);
      va_end(va);

#if !defined (__SYMBIAN32__)
      fprintf(stderr, "WARNING: %s!\n", buf);
#endif

#if defined( USE_WINDBG )
      strcat(buf, "\n");
#if defined( _WIN32_WCE )
      TCHAR buf_unicode[1024];
      MultiByteToWideChar(CP_ACP, 0, buf, strlen(buf) + 1, buf_unicode, sizeof(buf_unicode));
      OutputDebugString(buf_unicode);
#else
      OutputDebugString(buf);
#endif
#endif
}

#endif

void NORETURN error(const char *s, ...) {
      char buf_input[STRINGBUFLEN];
      char buf_output[STRINGBUFLEN];
      va_list va;

      // Generate the full error message
      va_start(va, s);
      vsnprintf(buf_input, STRINGBUFLEN, s, va);
      va_end(va);


      // Next, give the active engine (if any) a chance to augment the message
      if (g_engine) {
            g_engine->errorString(buf_input, buf_output, STRINGBUFLEN);
      } else {
            strncpy(buf_output, buf_input, STRINGBUFLEN);
            buf_output[STRINGBUFLEN-1] = '\0';
      }


      // Print the error message to stderr
      fprintf(stderr, "%s!\n", buf_output);

      // Unless this error -originated- within the debugger itself, we
      // now invoke the debugger, if available / supported.
      if (g_engine) {
            GUI::Debugger *debugger = g_engine->getDebugger();
#ifdef _WIN32_WCE
            if (isSmartphone())
                  debugger = 0;
#endif
            if (debugger && !debugger->isAttached()) {
                  debugger->attach(buf_output);
                  debugger->onFrame();
            }
      }


#if defined( USE_WINDBG )
#if defined( _WIN32_WCE )
      TCHAR buf_output_unicode[1024];
      MultiByteToWideChar(CP_ACP, 0, buf_output, strlen(buf_output) + 1, buf_output_unicode, sizeof(buf_output_unicode));
      OutputDebugString(buf_output_unicode);
#ifndef DEBUG
      drawError(buf_output);
#else
      int cmon_break_into_the_debugger_if_you_please = *(int *)(buf_output + 1);    // bus error
      printf("%d", cmon_break_into_the_debugger_if_you_please);               // don't optimize the int out
#endif
#else
      OutputDebugString(buf_output);
#endif
#endif

#ifdef PALMOS_MODE
      extern void PalmFatalError(const char *err);
      PalmFatalError(buf_output);
#endif

#ifdef __SYMBIAN32__
      Symbian::FatalError(buf_output);
#endif
      // Finally exit. quit() will terminate the program if g_system is present
      if (g_system)
            g_system->quit();

      exit(1);
}

Common::String tag2string(uint32 tag) {
      char str[5];
      str[0] = (char)(tag >> 24);
      str[1] = (char)(tag >> 16);
      str[2] = (char)(tag >> 8);
      str[3] = (char)tag;
      str[4] = '\0';
      return Common::String(str);
}

Generated by  Doxygen 1.6.0   Back to index