(*

 * Hedgewars, a free turn based strategy game

 * Copyright (c) 2004-2015 Andrey Korotaev <unC0Rr@gmail.com>

 *

 * 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; version 2 of the License

 *

 * 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 St, Fifth Floor, Boston, MA  02110-1301  USA

 *)

{$INCLUDE "options.inc"}

unit uUtils;

interface

uses uTypes, uFloat;

// returns s with whitespaces (chars <= #32) removed form both ends

function Trim(s: shortstring) : shortstring;

procedure SplitBySpace(var a, b: shortstring);

procedure SplitByChar(var a, b: shortstring; c: char);

procedure SplitByCharA(var a, b: ansistring; c: char);

procedure EscapeCharA(var a: ansistring; e: char);

procedure UnEscapeCharA(var a: ansistring; e: char);

function ExtractFileDir(s: shortstring) : shortstring;

function ExtractFileName(s: shortstring) : shortstring;

function  EnumToStr(const en : TGearType) : shortstring; overload;

function  EnumToStr(const en : TVisualGearType) : shortstring; overload;

function  EnumToStr(const en : TSound) : shortstring; overload;

function  EnumToStr(const en : TAmmoType) : shortstring; overload;

function  EnumToStr(const en : TStatInfoType) : shortstring; overload;

function  EnumToStr(const en : THogEffect) : shortstring; overload;

function  EnumToStr(const en : TCapGroup) : shortstring; overload;

function  EnumToStr(const en : TSprite) : shortstring; overload;

function  EnumToStr(const en : TMapGen) : shortstring; overload;

function  EnumToStr(const en : TWorldEdge) : shortstring; overload;

function  Min(a, b: LongInt): LongInt; inline;

function  MinD(a, b: double) : double; inline;

function  Max(a, b: LongInt): LongInt; inline;

function  IntToStr(n: LongInt): shortstring;

function  StrToInt(s: shortstring): LongInt;

//function  StrToInt(s: shortstring; var success: boolean): LongInt;

function  FloatToStr(n: hwFloat): shortstring;

function  DxDy2Angle(const _dY, _dX: hwFloat): real; inline;

function  DxDy2Angle32(const _dY, _dX: hwFloat): LongInt;

function  DxDy2AttackAngle(const _dY, _dX: hwFloat): LongInt;

function  DxDy2AttackAnglef(const _dY, _dX: extended): LongInt;

procedure SetLittle(var r: hwFloat);

function  Str2PChar(const s: shortstring): PChar;

function  DecodeBase64(s: shortstring): shortstring;

function  isPowerOf2(i: Longword): boolean;

function  toPowerOf2(i: Longword): Longword; inline;

function  endian(independent: LongWord): LongWord; inline;

function  CheckCJKFont(s: ansistring; font: THWFont): THWFont;

procedure AddFileLog(s: shortstring);

procedure AddFileLogRaw(s: pchar); cdecl;

function  CheckNoTeamOrHH: boolean; inline;

function  GetLaunchX(at: TAmmoType; dir: LongInt; angle: LongInt): LongInt;

function  GetLaunchY(at: TAmmoType; angle: LongInt): LongInt;

function CalcWorldWrap(X, radius: LongInt): LongInt;

procedure updateVolumeDelta(precise: boolean);

procedure updateCursorMovementDelta(precise: boolean; dir: LongInt; var cursorVar: LongInt);

function read1stLn(filePath: shortstring): shortstring;

function readValueFromINI(key, filePath: shortstring): shortstring;

{$IFNDEF PAS2C}

procedure Write(var f: textfile; s: shortstring);

procedure WriteLn(var f: textfile; s: shortstring);

function StrLength(s: PChar): Longword;

procedure SetLengthA(var s: ansistring; len: Longword);

{$ENDIF}

function  isPhone: Boolean; inline;

{$IFDEF IPHONEOS}

procedure startLoadingIndicator; cdecl; external;

procedure stopLoadingIndicator; cdecl; external;

procedure saveFinishedSynching; cdecl; external;

function  isApplePhone: Boolean; cdecl; external;

procedure AudioServicesPlaySystemSound(num: LongInt); cdecl; external;

{$ENDIF}

function  sanitizeForLog(s: shortstring): shortstring;

function  sanitizeCharForLog(c: char): shortstring;

procedure initModule(isNotPreview: boolean);

procedure freeModule;

implementation

uses {$IFNDEF PAS2C}typinfo, SDLh, {$ENDIF}Math, uConsts, uVariables, uPhysFSLayer, uDebug;

{$IFDEF DEBUGFILE}

var logFile: PFSFile;

{$IFDEF USE_VIDEO_RECORDING}

    logMutex: PSDL_mutex; // mutex for debug file

{$ENDIF}

{$ENDIF}

var CharArray: array[0..255] of Char;

// All leading/tailing characters with ordinal values less than or equal to 32 (a space) are stripped.

function Trim(s: shortstring) : shortstring;

var len, left, right: integer;

begin

len:= Length(s);

if len = 0 then

    exit(s);

// find first non-whitespace

left:= 1;

while left <= len do

    begin

    if s[left] > #32 then

        break;

    inc(left);

    end;

// find last non-whitespace

right:= len;

while right >= 1 do

    begin

    if s[right] > #32 then

        break;

    dec(right);

    end;

// string is whitespace only

if left > right then

    exit('');

// get string without surrounding whitespace

len:= right - left + 1;

Trim:= copy(s, left, len);

end;

function GetLastSlashPos(var s: shortString) : integer;

var lslash: integer;

    c: char;

begin

// find last slash

lslash:= Length(s);

while lslash >= 1 do

    begin

    c:= s[lslash];

    if (c = #47) or (c = #92) then

        break;

    dec(lslash); end;

GetLastSlashPos:= lslash;

end;

function ExtractFileDir(s: shortstring) : shortstring;

var lslash: byte;

begin

if Length(s) = 0 then

    exit(s);

lslash:= GetLastSlashPos(s);

if lslash <= 1 then

    exit('');

s[0]:= char(lslash - 1);

ExtractFileDir:= s;

end;

function ExtractFileName(s: shortstring) : shortstring;

var lslash, len: byte;

begin

len:= Length(s);

if len = 0 then

    exit(s);

lslash:= GetLastSlashPos(s);

if lslash < 1 then

    exit(s);

if lslash = len then

    exit('');

len:= len - lslash;

ExtractFilename:= copy(s, lslash + 1, len);

end;

procedure SplitBySpace(var a,b: shortstring);

begin

SplitByChar(a,b,' ');

end;

procedure SplitByChar(var a, b: shortstring; c : char);

var i: LongInt;

begin

i:= Pos(c, a);

if i > 0 then

    begin

    b:= copy(a, i + 1, Length(a) - i);

    a[0]:= char(Pred(i))

    {$IFDEF PAS2C}

       a[i] := 0;

    {$ENDIF}

    end

else

    b:= '';

end;

{$IFNDEF PAS2C}

procedure SetLengthA(var s: ansistring; len: Longword);

begin

    SetLength(s, len)

end;

{$ENDIF}

procedure SplitByCharA(var a, b: ansistring; c: char);

var i: LongInt;

begin

i:= Pos(c, a);

if i > 0 then

    begin

    b:= copy(a, i + 1, Length(a) - i);

    SetLengthA(a, Pred(i));

    end else b:= '';

end; { SplitByCharA }

// In the ansistring a, escapes all instances of

// '\e' with an ASCII ESC character, where e is

// a char chosen by you.

procedure EscapeCharA(var a: ansistring; e: char);

var i: LongInt;

begin

repeat

    i:= Pos(e, a);

    if (i > 1) and (a[i - 1] = '\') then

        begin

        a[i]:= Char($1B); // ASCII ESC

        Delete(a, i - 1, 1);

        end

    else

        break;

until (i <= 0);

end; { EscapeCharA }

// Unescapes a previously escaped string and inserts

// e back into the string. e is a char chosen by you.

procedure UnEscapeCharA(var a: ansistring; e: char);

var i: LongInt;

begin

repeat

    i:= Pos(Char($1B), a); // ASCII ESC

    if (i > 0) then

        begin

        a[i]:= e;

        end

    else

        break;

until (i <= 0);

end; { UnEscapeCharA }

function EnumToStr(const en : TGearType) : shortstring; overload;

begin

EnumToStr:= GetEnumName(TypeInfo(TGearType), ord(en))

end;

function EnumToStr(const en : TVisualGearType) : shortstring; overload;

begin

EnumToStr:= GetEnumName(TypeInfo(TVisualGearType), ord(en))

end;

function EnumToStr(const en : TSound) : shortstring; overload;

begin

EnumToStr:= GetEnumName(TypeInfo(TSound), ord(en))

end;

function EnumToStr(const en : TAmmoType) : shortstring; overload;

begin

EnumToStr:= GetEnumName(TypeInfo(TAmmoType), ord(en))

end;

function EnumToStr(const en : TStatInfoType) : shortstring; overload;

begin

EnumToStr:= GetEnumName(TypeInfo(TStatInfoType), ord(en))

end;

function EnumToStr(const en: THogEffect) : shortstring; overload;

begin

EnumToStr := GetEnumName(TypeInfo(THogEffect), ord(en))

end;

function EnumToStr(const en: TCapGroup) : shortstring; overload;

begin

EnumToStr := GetEnumName(TypeInfo(TCapGroup), ord(en))

end;

function EnumToStr(const en: TSprite) : shortstring; overload;

begin

EnumToStr := GetEnumName(TypeInfo(TSprite), ord(en))

end;

function EnumToStr(const en: TMapGen) : shortstring; overload;

begin

EnumToStr := GetEnumName(TypeInfo(TMapGen), ord(en))

end;

function EnumToStr(const en: TWorldEdge) : shortstring; overload;

begin

EnumToStr := GetEnumName(TypeInfo(TWorldEdge), ord(en))

end;

function Min(a, b: LongInt): LongInt;

begin

if a < b then

    Min:= a

else

    Min:= b

end;

function MinD(a, b: double): double;

begin

if a < b then

    MinD:= a

else

    MinD:= b

end;

function Max(a, b: LongInt): LongInt;

begin

if a > b then

    Max:= a

else

    Max:= b

end;

function IntToStr(n: LongInt): shortstring;

begin

str(n, IntToStr)

end;

// Convert string to longint, with error checking.

// Success will be set to false when conversion failed.

// See documentation on Val procedure for syntax of s

//function StrToInt(s: shortstring; var success: boolean): LongInt;

//var Code: Word;

//begin

//val(s, StrToInt, Code);

//success:= Code = 0;

//end;

// Convert string to longint, without error checking

function StrToInt(s: shortstring): LongInt;

begin

val(s, StrToInt);

end;

function FloatToStr(n: hwFloat): shortstring;

begin

FloatToStr:= cstr(n) + '_' + inttostr(Lo(n.QWordValue))

end;

function DxDy2Angle(const _dY, _dX: hwFloat): real; inline;

var dY, dX: Extended;

begin

dY:= hwFloat2Float(_dY);

dX:= hwFloat2Float(_dX);

DxDy2Angle:= arctan2(dY, dX) * 180 / pi

end;

function DxDy2Angle32(const _dY, _dX: hwFloat): LongInt;

const _16divPI: Extended = 16/pi;

var dY, dX: Extended;

begin

dY:= hwFloat2Float(_dY);

dX:= hwFloat2Float(_dX);

DxDy2Angle32:= trunc(arctan2(dY, dX) * _16divPI) and $1f

end;

function DxDy2AttackAngle(const _dY, _dX: hwFloat): LongInt;

const MaxAngleDivPI: Extended = cMaxAngle/pi;

var dY, dX: Extended;

begin

dY:= hwFloat2Float(_dY);

dX:= hwFloat2Float(_dX);

DxDy2AttackAngle:= trunc(arctan2(dY, dX) * MaxAngleDivPI)

end;

function DxDy2AttackAnglef(const _dY, _dX: extended): LongInt; inline;

begin

DxDy2AttackAnglef:= trunc(arctan2(_dY, _dX) * (cMaxAngle/pi))

end;

procedure SetLittle(var r: hwFloat);

begin

r:= SignAs(cLittle, r)

end;

function isPowerOf2(i: Longword): boolean;

begin

isPowerOf2:= (i and (i - 1)) = 0

end;

function toPowerOf2(i: Longword): Longword;

begin

toPowerOf2:= 1;

while (toPowerOf2 < i) do toPowerOf2:= toPowerOf2 shl 1

end;

function DecodeBase64(s: shortstring): shortstring;

const table = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';

var i, t, c: LongInt;

begin

c:= 0;

for i:= 1 to Length(s) do

    begin

    t:= Pos(s[i], table);

    if s[i] = '=' then

        inc(c);

    if t > 0 then

        s[i]:= char(t - 1)

    else

        s[i]:= #0

    end;

i:= 1;

t:= 1;

while i <= length(s) do

    begin

    DecodeBase64[t    ]:= char((byte(s[i    ]) shl 2) or (byte(s[i + 1]) shr 4));

    DecodeBase64[t + 1]:= char((byte(s[i + 1]) shl 4) or (byte(s[i + 2]) shr 2));

    DecodeBase64[t + 2]:= char((byte(s[i + 2]) shl 6) or (byte(s[i + 3])      ));

    inc(t, 3);

    inc(i, 4)

    end;

if c < 3 then

    t:= t - c;

DecodeBase64[0]:= char(t - 1)

end;

function Str2PChar(const s: shortstring): PChar;

var i :Integer ;

begin

   for i:= 1 to Length(s) do

      begin

      CharArray[i - 1] := s[i];

      end;

   CharArray[Length(s)]:= #0;

   Str2PChar:= @(CharArray[0]);

end;

function endian(independent: LongWord): LongWord; inline;

begin

{$IFDEF ENDIAN_LITTLE}

endian:= independent;