util.h

/* 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef DIRECTOR_UTIL_H
#define DIRECTOR_UTIL_H

namespace Common {
class String;
class FSNode;
class Path;
}

namespace Director {

int castNumToNum(const char *str);
char *numToCastNum(int num);

bool isAbsolutePath(const Common::String &path);

Common::Path toSafePath(const Common::String &path);
Common::String convertPath(const Common::String &path);

Common::String unixToMacPath(const Common::String &path);

Common::String getPath(const Common::String &path, const Common::String &cwd);

Common::Path resolveFSPath(const Common::String &path, const Common::Path &base, bool directory);
Common::Path resolvePathInner(const Common::String &path, const Common::Path &base, bool directory, const char *ext);
Common::Path resolvePath(const Common::String &path, const Common::Path &base, bool directory, const char **exts);
Common::Path resolvePartialPath(const Common::String &path, const Common::Path &base, bool directory, const char **exts);
Common::Path resolvePathWithFuzz(const Common::String &path, const Common::Path &base, bool directory, const char **exts);
Common::Path resolvePartialPathWithFuzz(const Common::String &path, const Common::Path &base, bool directory, const char **exts);
Common::Path findAbsolutePath(const Common::String &path, bool directory = false, const char **exts = nullptr);
Common::Path findPath(const Common::Path &path, bool currentFolder = true, bool searchPaths = true, bool directory = false, const char **exts = nullptr);
Common::Path findPath(const Common::String &path, bool currentFolder = true, bool searchPaths = true, bool directory = false, const char **exts = nullptr, Common::String currentPath_ = "");
Common::Path findMoviePath(const Common::String &path, bool currentFolder = true, bool searchPaths = true, Common::String currentPath = "");
Common::Path findXLibPath(const Common::String &path, bool currentFolder = true, bool searchPaths = true);
Common::Path findAudioPath(const Common::String &path, bool currentFolder = true, bool searchPaths = true);

Common::String getFileNameFromModal(bool save, const Common::String &suggested, const Common::String &title, const char *ext = "txt");
Common::String savePrefix();

bool hasExtension(Common::String filename);

Common::String getFileName(Common::String path);

Common::String stripMacPath(const char *name);

Common::String convertMacFilename(const char *name);

Common::Path dumpScriptName(const char *prefix, int type, int id, const char *ext);
Common::Path dumpFactoryName(const char *prefix, const char *name, const char *ext);

bool isButtonSprite(SpriteType spriteType);

uint32 macTimeSeed();

class RandomState {
public:
    uint32 _seed;
    uint32 _mask;
    uint32 _len;

    RandomState() {
        _seed = _mask = _len = 0;
    }

    void setSeed(uint32 seed, bool runInit = true);
    uint32 getSeed() { return _seed; }
    int32 getRandom(int32 range);

private:
    void init(int len);
    int32 genNextRandom();
    int32 perlin(int32 val);
};

uint32 readVarInt(Common::SeekableReadStream &stream);

Common::SeekableReadStreamEndian *readZlibData(Common::SeekableReadStream &stream, uint32 len, uint32 *outLen, bool bigEndian);

uint16 humanVersion(uint16 ver);

Common::Platform platformFromID(uint16 id);

Common::CodePage getEncoding(Common::Platform platform, Common::Language language);
Common::CodePage detectFontEncoding(Common::Platform platform, uint16 fontId);

int charToNum(Common::u32char_type_t ch);
Common::u32char_type_t numToChar(int num);
int compareStringOrder(const Common::String &s1, const Common::String &s2);
bool compareStringEquality(const Common::String &s1, const Common::String &s2);

// Our implementation of strstr() with Director character order
const char *d_strstr(const char *str, const char *substr);

Common::String encodePathForDump(const Common::String &path);

Common::String utf8ToPrintable(const Common::String &str);

Common::String decodePlatformEncoding(Common::String input);

Common::String formatStringForDump(const Common::String &str);

inline byte lerpByte(byte a, byte b, int alpha, int span) {
    int ai = static_cast<int>(a);
    int bi = static_cast<int>(b);
    span = CLIP<int>(span, 1, span);
    alpha = CLIP<int>(alpha, 0, span);
    return static_cast<byte>((bi * alpha + ai * (span - alpha)) / span);
}

inline void lerpPalette(byte *target, const byte *palA, int palALength, const byte *palB, int palBLength, int alpha, int span) {
    for (int i = 0; i < 768; i++) {
        target[i] = lerpByte(
            i < palALength * 3 ? palA[i] : 0,
            i < palBLength * 3 ? palB[i] : 0,
            alpha,
            span
        );
    }
}

} // End of namespace Director

double readAppleFloat80(void *ptr);
void hexdumpIfNotZero(byte *data, int len, const char *prefix);

#endif