string.qh File Reference

#include "nil.qh"
#include "sort.qh"
#include "oo.qh"

Include dependency graph for string.qh:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	DAYS_UP_TO_EPOCH   719469
#define	DEC_TO_HEXDIGIT(d)
#define	endsWith(this, suffix)
#define	EVAL_PAR(...)
#define	HEXDIGIT_TO_DEC(d)
#define	HEXDIGIT_TO_DEC_RAW(d)
#define	IS_DIGIT(d)
#define	IS_HEXDIGIT(d)
#define	mmsst(tm, compact)
#define	mmssth(tm, compact)
#define	PAGE_TEXT   _page_text
#define	PAGE_TEXT_INIT()
#define	PAR(...)
	Adds an individually translatable paragraph to PAGE_TEXT without having to deal with strcat and sprintf.
#define	PAR_1(msg)
#define	PAR_2(msg, a1)
#define	PAR_3(msg, a1, a2)
#define	PAR_4(msg, a1, a2, a3)
#define	PAR_5(msg, a1, a2, a3, a4)
#define	PAR_6(msg, a1, a2, a3, a4, a5)
#define	PAR_7(msg, a1, a2, a3, a4, a5, a6)
#define	PAR_8(msg, a1, a2, a3, a4, a5, a6, a7)
#define	PAR_9(msg, a1, a2, a3, a4, a5, a6, a7, a8)
#define	startsWith(haystack, needle)
#define	strcpy(this, s)
#define	strfree(this)
#define	strhasword(s, w)
#define	VM_TEMPSTRING_MAXSIZE   16383

Functions
ERASEABLE void	_shufflewords_swapfunc (float i, float j, entity pass)
ERASEABLE int	buf_load (string pFilename)
ERASEABLE void	buf_save (float buf, string pFilename)
ERASEABLE string	car (string s)
	Returns first word.
string	CCR (string input)
	color code replace, place inside of sprintf and parse the string
ERASEABLE string	cdr (string s)
	Returns all but first word.
ERASEABLE vector	checkColorCode (string theText, int text_len, int pos, bool check_at_the_end)
	Returns 0 if pos is NOT in the middle or at the end of a color code otherwise it returns a vector with color code length as the first component and the offset from '^' position to pos as the second component e.g.: "j^2kl" | returns 0 if pos == 0 or 1 or 4 ^^ | returns '2 1' or '2 2' if pos == 2 or 3.
ERASEABLE string	clockedtime_tostring (int tm, bool hundredths, bool compact)
ERASEABLE string	ColorTranslateRGB (string s)
ERASEABLE string	cons (string a, string b)
ERASEABLE string	cons_mid (string a, string mid, string b)
ERASEABLE int	days_up_to_date (int Y, int M, int D)
	Returns the number of days since 0000-03-01 (March 1, year 0).
ERASEABLE string	format_time (float seconds)
ERASEABLE string	fstrunzone (string s)
	unzone the string, and return it as tempstring. Safe to be called on string_null
ERASEABLE string	ftos_decimals (float number, int decimals)
	Converts a number to a string with the indicated number of decimals.
ERASEABLE string	ftos_decimals_percentage (float number, int decimals)
	Converts a percentage to a string with the indicated number of decimals.
ERASEABLE string	ftos_mindecimals (float number)
	Converts a number to a string with the minimum number of decimals It assumes that an extreme accuracy of the input number is not needed and reduces the max number of decimals to 4 in order to hide minor representation errors that can easily happen even with small numbers, e.g.: x = 32.1; sprintf("%f", x): "32.099998" x = 4; x += 0.01; x += 0.01; sprintf("%f", x): "4.020001" Reducing the max number of decimals to 5 is not enough to hide most errors.
ERASEABLE bool	isCaretEscaped (string theText, float pos)
	Returns true if the caret at position pos is escaped.
ERASEABLE bool	isInvisibleString (string s)
ERASEABLE bool	isValidColorCodeValue (string theText, int cc_len, int tag_start)
ERASEABLE string	seconds_tostring (float seconds)
ERASEABLE string	shufflewords (string str)
ERASEABLE bool	startsWithNocase (string haystack, string needle)
ERASEABLE string	strftime_s ()
	Returns the number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC).
float	stringwidth_colors (string s, vector theSize)
float	stringwidth_nocolors (string s, vector theSize)
ERASEABLE string	strwords (string s, int w)
ERASEABLE string	substring_range (string s, float b, float e)
ERASEABLE string	swapwords (string str, float i, float j)
ERASEABLE int	u8_strsize (string s)
ERASEABLE string	unescape (string in)
ERASEABLE int	vercmp (string v1, string v2)
ERASEABLE int	vercmp_recursive (string v1, string v2)

Variables
noref string	_endsWith_suffix
string	_shufflewords_str
string	autocvar_hud_colorset_background = "7"
	BG - White : neutral/unimportant text.
string	autocvar_hud_colorset_foreground_1 = "2"
	F1 - Green : primary priority (important names, etc).
string	autocvar_hud_colorset_foreground_2 = "3"
	F2 - Yellow : secondary priority (items, locations, numbers, etc).
string	autocvar_hud_colorset_foreground_3 = "4"
	F3 - Blue : tertiary priority or relatively inconsequential text.
string	autocvar_hud_colorset_foreground_4 = "1"
	F4 - Red : notice/attention grabbing texting.
string	autocvar_hud_colorset_kill_1 = "1"
	K1 - Red : "bad" or "dangerous" text (death messages against you, kill notifications, etc).
string	autocvar_hud_colorset_kill_2 = "3"
	K2 - Yellow : similar to above, but less important... OR, a highlight out of above message type.
string	autocvar_hud_colorset_kill_3 = "4"
	K3 - Blue : "good" or "beneficial" text (you fragging someone, etc).
int	ColorTranslateMode
const string	DIGITS = "0123456789"
const string	HEXDIGITS = "0123456789ABCDEF0123456789abcdef"
const string	HEXDIGITS_MINSET = "0123456789ABCDEFabcdef"

Macro Definition Documentation

DAYS_UP_TO_EPOCH

#define DAYS_UP_TO_EPOCH   719469

Definition at line 82 of file string.qh.

Referenced by strftime_s().

DEC_TO_HEXDIGIT

#define DEC_TO_HEXDIGIT

(

d

)

Value:

(substring(HEXDIGITS_MINSET, (d), 1))

Definition at line 579 of file string.qh.

Referenced by rgb_to_hexcolor().

endsWith

#define endsWith	(		this,
			suffix )

Value:

(_endsWith_suffix = suffix, substring(this, -strlen(_endsWith_suffix), -1) == _endsWith_suffix)

Definition at line 243 of file string.qh.

Referenced by spawnfunc().

EVAL_PAR

#define EVAL_PAR

(

...

)

Value:

__VA_ARGS__

Definition at line 658 of file string.qh.

HEXDIGIT_TO_DEC

#define HEXDIGIT_TO_DEC

(

d

)

Value:

((HEXDIGIT_TO_DEC_RAW(d) | 0x10) - 0x10)

Definition at line 578 of file string.qh.

Referenced by InputBox_draw().

HEXDIGIT_TO_DEC_RAW

#define HEXDIGIT_TO_DEC_RAW

(

d

)

Value:

(strstrofs(HEXDIGITS, (d), 0))

Definition at line 577 of file string.qh.

IS_DIGIT

#define IS_DIGIT

(

d

)

Value:

(strstrofs(DIGITS, (d), 0) >= 0)

Definition at line 583 of file string.qh.

Referenced by bot_cmd_eval(), find_last_color_code(), InputBox_draw(), isValidColorCodeValue(), translate_key(), and XonoticServerList_drawListBoxItem().

IS_HEXDIGIT

#define IS_HEXDIGIT

(

d

)

Value:

(strstrofs(HEXDIGITS_MINSET, (d), 0) >= 0)

Definition at line 580 of file string.qh.

Referenced by find_last_color_code(), and isValidColorCodeValue().

mmsst

#define mmsst	(		tm,
			compact )

Value:

clockedtime_tostring(tm, false, compact)

Definition at line 173 of file string.qh.

mmssth

#define mmssth	(		tm,
			compact )

Value:

clockedtime_tostring(tm, true,  compact)

Definition at line 174 of file string.qh.

PAGE_TEXT

#define PAGE_TEXT   _page_text

Definition at line 651 of file string.qh.

Referenced by PAR(), PAR(), PAR(), PAR(), PAR(), PAR(), PAR(), PAR(), PAR(), PAR(), PAR(), PAR(), PAR(), PAR(), and PAR().

PAGE_TEXT_INIT

#define PAGE_TEXT_INIT

(

)

Value:

string _page_text = ""

Definition at line 650 of file string.qh.

PAR

#define PAR

(

...

)

Value:

EVAL_PAR(OVERLOAD(PAR, __VA_ARGS__))

Adds an individually translatable paragraph to PAGE_TEXT without having to deal with strcat and sprintf.

Secondary arguments are optional format arguments for internal sprintf calls. This is to make translators' work easier: paragraphs are shorter than the whole page, sometimes they can be shared across pages (reducing translatable text) and don't require translators to check the whole text in the case of a paragraph update.

Definition at line 657 of file string.qh.

PAR_1

#define PAR_1

(

msg

)

Value:

_page_text = (_page_text == "" ? msg : strcat(_page_text, "\n\n", msg))

Definition at line 659 of file string.qh.

PAR_2

#define PAR_2	(		msg,
			a1 )

Value:

MACRO_BEGIN string _msg = sprintf(msg, a1); PAR_1(_msg); MACRO_END

Definition at line 660 of file string.qh.

PAR_3

#define PAR_3	(		msg,
			a1,
			a2 )

Value:

MACRO_BEGIN string _msg = sprintf(msg, a1, a2); PAR_1(_msg); MACRO_END

Definition at line 661 of file string.qh.

PAR_4

#define PAR_4	(		msg,
			a1,
			a2,
			a3 )

Value:

MACRO_BEGIN string _msg = sprintf(msg, a1, a2, a3); PAR_1(_msg); MACRO_END

Definition at line 662 of file string.qh.

PAR_5

#define PAR_5	(		msg,
			a1,
			a2,
			a3,
			a4 )

Value:

MACRO_BEGIN string _msg = sprintf(msg, a1, a2, a3, a4); PAR_1(_msg); MACRO_END

Definition at line 663 of file string.qh.

PAR_6

#define PAR_6	(		msg,
			a1,
			a2,
			a3,
			a4,
			a5 )

Value:

MACRO_BEGIN string _msg = sprintf(msg, a1, a2, a3, a4, a5); PAR_1(_msg); MACRO_END

Definition at line 664 of file string.qh.

PAR_7

#define PAR_7	(		msg,
			a1,
			a2,
			a3,
			a4,
			a5,
			a6 )

Value:

MACRO_BEGIN string _msg = sprintf(msg, a1, a2, a3, a4, a5, a6); PAR_1(_msg); MACRO_END

Definition at line 665 of file string.qh.

PAR_8

#define PAR_8	(		msg,
			a1,
			a2,
			a3,
			a4,
			a5,
			a6,
			a7 )

Value:

MACRO_BEGIN string _msg = sprintf(msg, a1, a2, a3, a4, a5, a6, a7); PAR_1(_msg); MACRO_END

Definition at line 666 of file string.qh.

PAR_9

#define PAR_9	(		msg,
			a1,
			a2,
			a3,
			a4,
			a5,
			a6,
			a7,
			a8 )

Value:

MACRO_BEGIN string _msg = sprintf(msg, a1, a2, a3, a4, a5, a6, a7, a8); PAR_1(_msg); MACRO_END

Definition at line 667 of file string.qh.

startsWith

#define startsWith	(		haystack,
			needle )

Value:

(strstrofs(haystack, needle, 0) == 0)

Definition at line 234 of file string.qh.

Referenced by _getcommandkey(), _MapInfo_Generate(), spawnfunc(), startsWith(), W_Guide_Keybinds(), WarpZoneLib_BadEntity(), and XonoticKeyBinder_drawListBoxItem().

strcpy

#define strcpy	(		this,
			s )

Value:

    MACRO_BEGIN \
    if (this) \
        strunzone(this); \
    this = strzone(s); \
MACRO_END

Definition at line 51 of file string.qh.

#define strcpy(this, s) MACRO_BEGIN \
    if (this) \
        strunzone(this); \
    this = strzone(s); \
MACRO_END

Referenced by Accuracy_LoadLevels(), Announcer_Duel(), bd_do_next_match(), bd_move_dozer(), bd_server_event(), bd_set_next_match(), bd_set_nextlevel(), bot_custom_weapon_priority_setup(), bot_decodecommand(), centerprint_Add(), centerprint_SetDuelTitle(), centerprint_SetTitle(), Cmd_Scoreboard_SetFields(), CvarList_UpdateResults(), DamageText::DamageText_update(), Ent_WaypointSprite(), GameTypeVote_Finished(), GENERIC_COMMAND(), get_mi_min_max(), GetCvars_handleString(), GetCvars_handleString_Fixup(), HUD_Chat(), HUD_Main(), HUD_Mod_Race(), HUD_Panel_FirstInDrawQ(), HUD_Radar(), HUD_Vote(), HUD_Weapons(), ignore_add_player(), ignore_remove_player(), InitGameplayMode(), Label_draw(), Label_setText(), LoadPlayerSounds(), Local_Notification_sound(), LocalCommand_sendcvar(), m_goto(), m_tooltip(), Model::model_precache(), Monster_Sounds_Load(), MUTATOR_HOOKFUNCTION(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), net_handle_ServerWelcome(), OnlineBanList_Think(), PlayerFrame(), PlayerThink(), preMenuDraw(), ps_move_piece(), queue_to_execute_next_frame(), QuickMenu_Page_Load(), QuickMenu_Page_LoadEntry(), QuickMenu_skip_submenu(), race_checkAndWriteName(), race_deleteTime(), race_SendTime(), race_setTime(), sandbox_ObjectPort_Load(), Scoreboard_Draw(), SendWelcomeMessage(), Set_NextMap(), Sound::sound_precache(), spawnfunc(), StoreCheckpointSplits(), strcpy(), UpdatePlayerSounds(), W_FixWeaponOrder_ForceComplete_AndBuildImpulseList(), W_Reload(), waypoint_loadall(), waypoint_saveall(), welcomeDialog_resetStrings(), WinningConditionHelper(), WriteByte(), XonoticCampaignList_loadCvars(), XonoticCrosshairPreview_draw(), XonoticCvarList_setSelected(), XonoticGuideDescription_setDescription(), XonoticGuideDescription_wrapDescription(), XonoticMapInfoDialog_loadMapInfo(), XonoticMapList_keyDown(), XonoticMapList_refilter(), XonoticPlayerModelSelector_go(), XonoticScreenshotBrowserTab_loadPreviewScreenshot(), XonoticScreenshotImage_load(), XonoticScreenshotViewerDialog_loadScreenshot(), XonoticServerList_draw(), XonoticServerList_setSelected(), XonoticTextBox_setText(), and XonoticWelcomeDialog_readInputArgs().

strfree

#define strfree

(

this

)

Value:

    MACRO_BEGIN \
    if (this) \
        strunzone(this); \
    this = string_null; \
MACRO_END

Definition at line 57 of file string.qh.

#define strfree(this) MACRO_BEGIN \
    if (this) \
        strunzone(this); \
    this = string_null; \
MACRO_END

Referenced by DamageText::~DamageText(), DebugText3d::~DebugText3d(), Announcer_ClearTitle(), bd_editor_place(), bd_server_event(), bd_setup_pieces(), bd_unfill_recurse(), BGMScript_InitEntity(), bot_clientdisconnect(), c4_server_event(), CampaignFile_Unload(), centerprint_ClearTitle(), centerprint_KillAll(), ClearCheckpointSplits(), ClearPlayerSounds(), ClientDisconnect(), Cmd_Scoreboard_SetFields(), cvar_changes_init(), DemoList_Filter_Change(), end_minigame(), Ent_RemoveEntCS(), Ent_RemoveWaypointSprite(), EntryList_StringFilterBox_Change(), execute_next_frame(), GameType_ConfigureSliders(), GetCvars_handleString(), HUD_Crosshair(), HUD_Mod_Race(), HUDSkinList_Filter_Change(), HUDSkinList_SavedName_Change(), ignore_list_apply(), InputBox_setText(), ItemRemove(), LocalCommand_sendcvar(), m_init_delayed(), m_tooltip(), MapList_StringFilterBox_Change(), MapVote_Finished(), MapVote_Think(), MapVote_UnzoneStrings(), MUTATOR_HOOKFUNCTION(), MX_Say_(), NET_HANDLE(), NET_HANDLE(), Net_Notification_Remove(), nmm_kill_tiles(), PlayerStats_GameReport_FinalizePlayer(), PlayerStats_GameReport_Reset_All(), pp_move(), pp_server_event(), ps_move_piece(), ps_server_event(), QuickMenu_Close(), QuickMenu_Page_ClearEntry(), QuickMenu_skip_submenu(), race_CheckName(), race_ClearRecords(), rewrapCampaign(), sandbox_ObjectPort_Load(), sandbox_ObjectRemove(), Scoreboard_Rankings_Draw(), ScreenshotList_Filter_Change(), ServerList_Filter_Change(), Set_NextMap(), setZonedTooltip(), Shutdown(), SL_ProcessCategoryOverrides(), SoundList_Filter_Change(), StrafeHUD_UpdateSonarSound(), ttt_server_event(), url_fclose(), url_multi_ready(), url_single_fopen(), url_URI_Get_Callback(), VoteReset(), Welcome_Message_Show_Try(), XonoticCvarList_setSelected(), XonoticKeyBinder_destroy(), XonoticServerInfoDialog_loadServerInfo(), XonoticServerList_setSortOrder(), and XonoticTextBox_destroy().

strhasword

#define strhasword	(		s,
			w )

Value:

(strstrofs(strcat(" ", s, " "), strcat(" ", w, " "), 0) >= 0)

Definition at line 375 of file string.qh.

Referenced by CvarList_Revert_Click(), GL_CheckExtension(), Map_IsRecent(), Physics_Valid(), W_HitPlotOpen(), XonoticCvarList_drawListBoxItem(), and XonoticCvarList_updateCvarType().

VM_TEMPSTRING_MAXSIZE

#define VM_TEMPSTRING_MAXSIZE   16383

Definition at line 8 of file string.qh.

Referenced by cvar_changes_init().

Function Documentation

_shufflewords_swapfunc()

ERASEABLE void _shufflewords_swapfunc	(	float	i,
		float	j,
		entity	pass )

Definition at line 320 of file string.qh.

{
    _shufflewords_str = swapwords(_shufflewords_str, i, j);
}

References _shufflewords_str, entity(), pass, and swapwords().

Referenced by shufflewords().

buf_load()

ERASEABLE int buf_load

(

string

pFilename

)

Definition at line 444 of file string.qh.

{
    int buf = buf_create();
    if (buf < 0)
        return -1;
    int fh = fopen(pFilename, FILE_READ);
    if (fh < 0)
    {
        buf_del(buf);
        return -1;
    }
    string l;
    for (int i = 0; (l = fgets(fh)); ++i)
        bufstr_set(buf, i, l);
    fclose(fh);
    return buf;
}

References buf_create, fclose(), fgets(), FILE_READ, and fopen().

buf_save()

ERASEABLE void buf_save	(	float	buf,
		string	pFilename )

Definition at line 463 of file string.qh.

{
    int fh = fopen(pFilename, FILE_WRITE);
    if (fh < 0)
        error(strcat("Can't write buf to ", pFilename));
    int n = buf_getsize(buf);
    for (int i = 0; i < n; ++i)
        fputs(fh, strcat(bufstr_get(buf, i), "\n"));
    fclose(fh);
}

References error, fclose(), FILE_WRITE, fopen(), fputs(), and strcat().

car()

ERASEABLE string car

(

string

s

)

Returns first word.

Definition at line 258 of file string.qh.

{
    int o = strstrofs(s, " ", 0);
    if (o < 0)
        return s;
    return substring(s, 0, o);
}

References strstrofs, and substring().

Referenced by _MapInfo_Generate(), _MapInfo_Map_ApplyGametype(), _MapInfo_Map_ApplyGametypeEx(), _MapInfo_Parse_Settemp(), _MapInfo_ParseArena(), GameCommand_adminmsg(), GameCommand_moveplayer(), get_model_parameters(), GlobalSound_sample(), Local_Notification_centerprint_Add(), Local_Notification_HUD_Notify_Push(), Local_Notification_sprintf(), MapInfo_Get_ByName_NoFallbacks(), matchacl(), PrecacheGlobalSound(), Process_Notif_Args(), STATIC_INIT_LATE(), W_GetCycleWeapon(), and XonoticStatsList_getStats().

CCR()

string CCR

(

string

input

)

color code replace, place inside of sprintf and parse the string

Definition at line 214 of file string.qh.

{
    // foreground/normal colors
    input = strreplace("^F1", strcat("^", autocvar_hud_colorset_foreground_1), input);
    input = strreplace("^F2", strcat("^", autocvar_hud_colorset_foreground_2), input);
    input = strreplace("^F3", strcat("^", autocvar_hud_colorset_foreground_3), input);
    input = strreplace("^F4", strcat("^", autocvar_hud_colorset_foreground_4), input);
 
    // "kill" colors
    input = strreplace("^K1", strcat("^", autocvar_hud_colorset_kill_1), input);
    input = strreplace("^K2", strcat("^", autocvar_hud_colorset_kill_2), input);
    input = strreplace("^K3", strcat("^", autocvar_hud_colorset_kill_3), input);
 
    // background colors
    input = strreplace("^BG", strcat("^", autocvar_hud_colorset_background), input);
    input = strreplace("^N", "^7", input);  // "none"-- reset to white...
    return input;
}

References autocvar_hud_colorset_background, autocvar_hud_colorset_foreground_1, autocvar_hud_colorset_foreground_2, autocvar_hud_colorset_foreground_3, autocvar_hud_colorset_foreground_4, autocvar_hud_colorset_kill_1, autocvar_hud_colorset_kill_2, autocvar_hud_colorset_kill_3, and strcat().

Referenced by centerprint_SetTitle(), hash_replace(), net_handle_ServerWelcome(), notif_arg_frag_ping(), notif_arg_frag_stats(), and notif_arg_spree_inf().

cdr()

ERASEABLE string cdr

(

string

s

)

Returns all but first word.

Definition at line 268 of file string.qh.

{
    int o = strstrofs(s, " ", 0);
    if (o < 0)
        return string_null;
    return substring(s, o + 1, strlen(s) - (o + 1));
}

References string_null, strlen, strstrofs, and substring().

Referenced by _MapInfo_Generate(), _MapInfo_Map_ApplyGametype(), _MapInfo_Map_ApplyGametypeEx(), _MapInfo_Parse_Settemp(), _MapInfo_ParseArena(), GameCommand_adminmsg(), GameCommand_moveplayer(), get_model_parameters(), GlobalSound_sample(), Local_Notification_centerprint_Add(), Local_Notification_HUD_Notify_Push(), Local_Notification_sprintf(), MapInfo_Get_ByName_NoFallbacks(), matchacl(), PrecacheGlobalSound(), Process_Notif_Args(), STATIC_INIT_LATE(), and W_GetCycleWeapon().

checkColorCode()

ERASEABLE vector checkColorCode	(	string	theText,
		int	text_len,
		int	pos,
		bool	check_at_the_end )

Returns 0 if pos is NOT in the middle or at the end of a color code otherwise it returns a vector with color code length as the first component and the offset from '^' position to pos as the second component e.g.: "j^2kl" | returns 0 if pos == 0 or 1 or 4 ^^ | returns '2 1' or '2 2' if pos == 2 or 3.

Definition at line 616 of file string.qh.

{
    if (text_len == 0)
        text_len = strlen(theText);
    string tag_type = "^";
    int cc_len = 2;
    int tag_len = 1;
 
    LABEL(check_color_tag)
 
    int ofs = cc_len;
    if (!check_at_the_end)
        --ofs;
    for (; ofs >= 1; --ofs)
    {
        if (!(pos >= ofs && text_len >= pos + (cc_len - ofs)))
            continue;
        if (substring(theText, pos - ofs, tag_len) == tag_type)
        {
            if (!isCaretEscaped(theText, pos - ofs) && isValidColorCodeValue(theText, cc_len, pos - ofs))
                return eX * cc_len + eY * ofs;
        }
    }
    if (cc_len == 2)
    {
        tag_type = "^x";
        cc_len = 5;
        tag_len = 2;
        goto check_color_tag;
    }
    return '0 0 0';
}

References eX, eY, isCaretEscaped(), isValidColorCodeValue(), LABEL, strlen, substring(), and vector.

Referenced by textLengthUpToLength(), textLengthUpToWidth(), and XonoticColorpicker_mouseDrag().

clockedtime_tostring()

ERASEABLE string clockedtime_tostring	(	int	tm,
		bool	hundredths,
		bool	compact )

Parameters

[in]	tm	integer clocked time in tenths or hundredths, CANNOT be negative
[in]	hundredths	if true append hundredths too, otherwise only tenths
[in]	compact	if true leading 0s are omitted (except the seconds unit digit)

Returns

clocked time as "m:ss.t" or "m:ss.th" string (rounded)

Definition at line 145 of file string.qh.

{
    if (tm < 0)
    {
        if (compact)
            return strcat("0.0", hundredths ? "0" : "");
        else
            return strcat("0:00.0", hundredths ? "0" : "");
    }
    int acc = hundredths ? 6000 : 600;
    tm = floor(tm + 0.5);
    int minutes = floor(tm / acc);
    int tm_without_minutes = tm - minutes * acc;
    // NOTE: the start digit of s is a placeholder and won't be displayed
    string s = ftos(acc * 10 + tm_without_minutes);
    if (!compact || minutes > 0)
        return strcat(ftos(minutes), ":", substring(s, 1, 2), ".", substring(s, 3, hundredths ? 2 : 1));
 
    int ofs = 2, digits = 1;
    if (tm_without_minutes >= 10 * (hundredths ? 100 : 10))
    {
        ofs = 1;
        digits = 2;
    }
    return strcat(substring(s, ofs, digits), ".", substring(s, 3, hundredths ? 2 : 1));
 
}

References floor(), ftos(), strcat(), and substring().

ColorTranslateRGB()

ERASEABLE string ColorTranslateRGB

(

string

s

)

Definition at line 194 of file string.qh.

{
    return (ColorTranslateMode & 1) ? strdecolorize(s) : s;
}

References ColorTranslateMode.

Referenced by CSQC_Parse_Print(), entcs_GetName(), HUD_Mod_Race(), HUD_Notify(), HUD_Vote(), MakeRaceString(), MapVote_DrawSuggester(), minigame_show_allspecs(), Scoreboard_Draw(), and Scoreboard_Rankings_Draw().

cons()

ERASEABLE string cons	(	string	a,
		string	b )

Definition at line 277 of file string.qh.

{
    if (a == "")  return b;
    if (b == "")  return a;
    return strcat(a, " ", b);
}

References strcat().

Referenced by _json_parse_pair(), _MapInfo_ParseArena(), BanCommand_mute(), BanCommand_playban(), BanCommand_voteban(), Gametype::gametype_init(), GenericCommand_addtolist(), GenericCommand_maplist(), GenericCommand_removefromlist(), getlsmaps(), getmaplist(), ignore_add_player(), ignore_playerindb(), ignore_remove_player(), Map_MarkAsRecent(), MapList_Add_All(), Maplist_Init(), MUTATOR_HOOKFUNCTION(), spawnfunc(), W_Apply_Weaponreplace(), waypoint_loadall(), waypoint_saveall(), and XonoticPlayerList_drawListBoxItem().

cons_mid()

ERASEABLE string cons_mid	(	string	a,
		string	mid,
		string	b )

Definition at line 285 of file string.qh.

{
    if (a == "")  return b;
    if (b == "")  return a;
    return strcat(a, mid, b);
}

References strcat().

Referenced by _getcommandkey(), net_handle_ServerWelcome(), translate_weaponarena(), and XonoticKeyBinder_drawListBoxItem().

days_up_to_date()

ERASEABLE int days_up_to_date	(	int	Y,
		int	M,
		int	D )

Returns the number of days since 0000-03-01 (March 1, year 0).

Starting counting from March, as the 1st month of the year, February becomes the 12th and last month, so its variable duration does not affect, given that the 29th is the last day of the period

Definition at line 67 of file string.qh.

{
    int years = (M <= 2) ? Y - 1 : Y;
 
    int leap_days = floor(years / 4) - floor(years / 100) + floor(years / 400);
 
    // using these 2 formulas to save 2 arrays or switches (performance isn't important here)
    int months = (M <= 2) ? (M + 9) : (M - 3); // 10, 11, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
    int leftover_days = (M <= 2) ? (M + 5) : floor(0.58 * M - 1.1); // 6, 7, 0, 1, 1, 2, 2, 3, 4, 4, 5, 5
 
    int month_days = 30 * months + leftover_days;
 
    return 365 * years + month_days + D + leap_days;
}

References floor().

Referenced by strftime_s().

format_time()

ERASEABLE string format_time

(

float

seconds

)

Definition at line 177 of file string.qh.

{
    seconds = floor(seconds + 0.5);
    float days = floor(seconds / 864000);
    seconds -= days * 864000;
    float hours = floor(seconds / 36000);
    seconds -= hours * 36000;
    float minutes = floor(seconds / 600);
    seconds -= minutes * 600;
    if (days > 0)
        return sprintf(_("%d days, %02d:%02d:%02d"), days, hours, minutes, seconds);
    return sprintf(_("%02d:%02d:%02d"), hours, minutes, seconds);
}

References floor().

fstrunzone()

ERASEABLE string fstrunzone

(

string

s

)

unzone the string, and return it as tempstring. Safe to be called on string_null

Definition at line 247 of file string.qh.

{
    if (!s)
        return s;
    string sc = strcat(s, "");
    strunzone(s);
    return sc;
}

References strcat(), and strunzone().

ftos_decimals()

ERASEABLE string ftos_decimals	(	float	number,
		int	decimals )

Converts a number to a string with the indicated number of decimals.

Definition at line 476 of file string.qh.

{
    // inhibit stupid negative zero
    if (number == 0) number = 0;
    return sprintf("%.*f", decimals, number);
}

References number.

Referenced by dialog_hudpanel_main_settings(), DrawDomItem(), formatStringSpecial(), HUD_Physics(), HUD_Score(), MakeRaceString(), MixedSlider_addRange(), MUTATOR_HOOKFUNCTION(), StrafeHUD_DrawJumpHeight(), StrafeHUD_DrawStartSpeed(), StrafeHUD_DrawStrafeEfficiency(), StrafeHUD_DrawVerticalAngle(), updateSensField(), waypoint_save_links(), waypoint_saveall(), and XonoticDecibelsSlider_valueToText().

ftos_decimals_percentage()

ERASEABLE string ftos_decimals_percentage	(	float	number,
		int	decimals )

Converts a percentage to a string with the indicated number of decimals.

Definition at line 485 of file string.qh.

{
    if (number == 0)
        number = 0; // inhibit stupid negative zero
    return sprintf(_("%.*f%%"), decimals, number * 100); // translatable percentage string
}

References number.

Referenced by dialog_hudpanel_main_settings(), formatStringSpecial(), Scoreboard_AccuracyStats_Draw(), XonoticDecibelsSlider_valueToText(), XonoticLanguageList_drawListBoxItem(), XonoticScreenshotImage_draw(), and XonoticStatsList_getStats().

ftos_mindecimals()

ERASEABLE string ftos_mindecimals

(

float

number

)

Converts a number to a string with the minimum number of decimals It assumes that an extreme accuracy of the input number is not needed and reduces the max number of decimals to 4 in order to hide minor representation errors that can easily happen even with small numbers, e.g.: x = 32.1; sprintf("%f", x): "32.099998" x = 4; x += 0.01; x += 0.01; sprintf("%f", x): "4.020001" Reducing the max number of decimals to 5 is not enough to hide most errors.

Definition at line 502 of file string.qh.

{
    // inhibit stupid negative zero
    if (fabs(number) < 0.0001)
        return "0";
 
    int rounded = rint(number);
    if (fabs(number - rounded) < 0.0001)
        return ftos(rounded);
 
    string s = sprintf("%.4f", number);
 
    // if the decimal part got lost (large numbers), return what we got
    int dot_ofs = strstrofs(s, ".", 0);
    if (dot_ofs < 0)
        return s;
 
    // count trailing zeros that will need to be removed
    string ch = "";
    int i = 0;
    for (; i < 4; ++i)
    {
        ch = substring(s, -1 - i, -1 - i);
        if (ch != "0")
            break;
    }
 
    // no trailing zeros, return what we got
    // FLOAT_NAN falls under this case and returned as is ("-1.#IND")
    if (i == 0)
        return s;
 
    // if we've found 4 trailing zeros (i == 4) assume the next char is a dot and remove it too
    // ch == "." handles cases where the decimal part has less than 4 decimal digits (large numbers)
    if (i == 4 || ch == ".")
        ++i; // remove dot too
 
    return substring(s, 0, -1 - i);
}

References fabs(), ftos(), number, rint(), strstrofs, and substring().

Referenced by dialog_hudpanel_main_settings(), gettooltip_dependency_string_numeric(), HUD_Panel_InputEvent(), HUD_Panel_SetPos(), HUD_Panel_SetPosSize(), XonoticCheckBox_saveCvars(), XonoticMixedSlider_saveCvars(), and XonoticSlider_saveCvars().

isCaretEscaped()

ERASEABLE bool isCaretEscaped	(	string	theText,
		float	pos )

Returns true if the caret at position pos is escaped.

Definition at line 587 of file string.qh.

{
    // count all the previous carets
    int carets = 0;
    while (pos - carets >= 1 && substring(theText, pos - carets - 1, 1) == "^")
        ++carets;
    // if number of previous carets is odd then this carets is escaped
    return (carets & 1);
}

References substring().

Referenced by checkColorCode(), and XonoticColorpicker_mouseDrag().

isInvisibleString()

ERASEABLE bool isInvisibleString

(

string

s

)

Definition at line 392 of file string.qh.

{
    s = strdecolorize(s);
    bool utf8 = cvar("utf8_enable");
    for (int i = 0, n = strlen(s); i < n; ++i)
    {
        int c = str2chr(s, i);
        switch (c)
        {
            case 0:
            case 32:           // space
                break;
            case 192:          // charmap space
                if (!utf8)
                    break;
                return false;
            case 0xE000: // invisible char of the utf8 quake charmap
            case 0xE00A: // invisible char of the utf8 quake charmap
            case 0xE0A0: // invisible char of the utf8 quake charmap
            case 0xE020: // invisible char of the utf8 quake charmap
            case 0x00A0: // NO-BREAK SPACE
            case 0x180E: // MONGOLIAN VOWEL SEPARATOR
            case 0x2000: // EN QUAD
            case 0x2001: // EM QUAD
            case 0x2002: // EN SPACE
            case 0x2003: // EM SPACE
            case 0x2004: // THREE-PER-EM SPACE
            case 0x2005: // FOUR-PER-EM SPACE
            case 0x2006: // SIX-PER-EM SPACE
            case 0x2007: // FIGURE SPACE
            case 0x2008: // PUNCTUATION SPACE
            case 0x2009: // THIN SPACE
            case 0x200A: // HAIR SPACE
            case 0x200B: // ZERO WIDTH SPACE
            case 0x202F: // NARROW NO-BREAK SPACE
            case 0x205F: // MEDIUM MATHEMATICAL SPACE
            case 0x3000: // IDEOGRAPHIC SPACE
            case 0xFEFF: // ZERO WIDTH NO-BREAK SPACE
            case 0xFFA0: // Halfwidth Hangul Filler
            case 0x3164: // Hangul Filler
                if (utf8)
                    break;
            default:
                return false;
        }
    }
    return true;
}

References cvar(), str2chr, and strlen.

Referenced by PlayerFrame().

isValidColorCodeValue()

ERASEABLE bool isValidColorCodeValue	(	string	theText,
		int	cc_len,
		int	tag_start )

Definition at line 598 of file string.qh.

{
    if (cc_len == 2)
        return IS_DIGIT(substring(theText, tag_start + 1, 1));
    if (cc_len == 5)
        return (IS_HEXDIGIT(substring(theText, tag_start + 2, 1))
             && IS_HEXDIGIT(substring(theText, tag_start + 3, 1))
             && IS_HEXDIGIT(substring(theText, tag_start + 4, 1)));
    return false;
}

References IS_DIGIT, IS_HEXDIGIT, and substring().

Referenced by checkColorCode().

seconds_tostring()

ERASEABLE string seconds_tostring

(

float

seconds

)

Parameters

[in]

seconds

number of seconds, can be negative too

Returns

time as "m:ss" string (floored)

Definition at line 123 of file string.qh.

{
    bool negative = false;
    if (seconds < 0)
    {
        negative = true;
        seconds = -seconds;
        if (floor(seconds) != seconds)
            ++seconds; // make floor work in the other direction
    }
    int minutes = floor(seconds / 60);
    seconds -= minutes * 60;
    if (negative)
        return sprintf("-%d:%02d", minutes, seconds);
    return sprintf("%d:%02d", minutes, seconds);
}

References floor().

Referenced by formatmessage(), HUD_CenterPrint(), HUD_Pickup(), and HUD_Timer().

shufflewords()

ERASEABLE string shufflewords

(

string

str

)

Definition at line 326 of file string.qh.

{
    _shufflewords_str = str;
    int n = tokenizebyseparator(str, " ");
    shuffle(n, _shufflewords_swapfunc, NULL);
    str = _shufflewords_str;
    _shufflewords_str = string_null;
    return str;
}

References _shufflewords_str, _shufflewords_swapfunc(), NULL, shuffle(), string_null, and tokenizebyseparator.

startsWithNocase()

ERASEABLE bool startsWithNocase	(	string	haystack,
		string	needle )

Definition at line 237 of file string.qh.

{
    return strcasecmp(substring(haystack, 0, strlen(needle)), needle) == 0;
}

References strcasecmp, strlen, and substring().

Referenced by MapInfo_FindName().

strftime_s()

ERASEABLE string strftime_s

(

)

Returns the number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC).

This function exists only as a replacement for strftime(false, "%s") which doesn't work on Windows (s is not supported) and at least in some linux systems doesn't return the correct result. NOTE: at the current date, the number (string) returned by both strftime(false, "%s") and strftime_s() is so high that can't be converted to int (with ftos) without precision loss

Definition at line 91 of file string.qh.

{
    string date = strftime(false, "%Y-%m-%d %H:%M:%S");
    int i, seconds = 0;
    i =0; int Y = stof(substring(date, i, 4)); // years
    i+=5; int M = stof(substring(date, i, 2)); // months
    i+=3; int D = stof(substring(date, i, 2)); // days
 
    i+=3; seconds += stof(substring(date, i, 2)) * 60 * 60; // hours
    i+=3; seconds += stof(substring(date, i, 2)) * 60; // minutes
    i+=3; seconds += stof(substring(date, i, 2)); // seconds
 
    // doing so we loose precision
    //seconds += (days_up_to_date(Y, M, D) - DAYS_UP_TO_EPOCH) * 24 * 60 * 60;
    //return ftos(seconds);
 
    int days_since_epoch = days_up_to_date(Y, M, D) - DAYS_UP_TO_EPOCH;
    // use hundreds of seconds as unit to avoid precision loss
    int hundreds_of_seconds = days_since_epoch * 24 * 6 * 6;
    hundreds_of_seconds += floor(seconds / 100);
 
    // tens of seconds and seconds
    string seconds_str = ftos(seconds % 100);
    if ((seconds % 100) < 10)
        seconds_str = strcat("0", seconds_str);
 
    return strcat(ftos(hundreds_of_seconds), seconds_str);
}

References days_up_to_date(), DAYS_UP_TO_EPOCH, floor(), ftos(), stof(), strcat(), and substring().

Referenced by spawnfunc().

stringwidth_colors()

float stringwidth_colors	(	string	s,
		vector	theSize )

Definition at line 30 of file string.qh.

    {
        return stringwidth_builtin(s, true, theSize);
    }

References vector.

Referenced by centerprint_SetDuelTitle(), Checkpoints_drawstring(), Draw_ShowNames(), GameTypeVote_DrawGameTypeItem(), HUD_CenterPrint(), HUD_Chat(), HUD_Mod_Race(), HUD_Notify(), HUD_Quickmenu_DrawEntry(), HUD_Score_Rankings(), HUD_Vote(), InfoMessages_drawstring(), MakeRaceString(), minigame_drawcolorcodedstring_trunc(), minigame_drawcolorcodedstring_wrapped(), minigame_show_allspecs(), Scoreboard_Draw(), Scoreboard_DrawOthers(), Scoreboard_FixColumnWidth(), and Scoreboard_Rankings_Draw().

stringwidth_nocolors()

float stringwidth_nocolors	(	string	s,
		vector	theSize )

Definition at line 35 of file string.qh.

    {
        return stringwidth_builtin(s, false, theSize);
    }

References vector.

Referenced by HUD_Pickup(), MapVote_FormatMapItem(), minigame_drawstring_trunc(), and minigame_drawstring_wrapped().

strwords()

ERASEABLE string strwords	(	string	s,
		int	w )

Definition at line 365 of file string.qh.

{
    int endpos = 0;
    for (; w && endpos >= 0; --w)
        endpos = strstrofs(s, " ", endpos + 1);
    if (endpos < 0)
        return s;
    return substring(s, 0, endpos);
}

References strstrofs, and substring().

Referenced by Map_MarkAsRecent().

substring_range()

ERASEABLE string substring_range	(	string	s,
		float	b,
		float	e )

Definition at line 293 of file string.qh.

{
    return substring(s, b, e - b);
}

References substring().

Referenced by DamageText::DamageText_update(), and swapwords().

swapwords()

ERASEABLE string swapwords	(	string	str,
		float	i,
		float	j )

Definition at line 299 of file string.qh.

{
    string s1, s2, s3, s4, s5;
    float si, ei, sj, ej, s0, en;
    int n = tokenizebyseparator(str, " ");
    si = argv_start_index(i);
    sj = argv_start_index(j);
    ei = argv_end_index(i);
    ej = argv_end_index(j);
    s0 = argv_start_index(0);
    en = argv_end_index(n - 1);
    s1 = substring_range(str, s0, si);
    s2 = argv(i);
    s3 = substring_range(str, ei, sj);
    s4 = argv(j);
    s5 = substring_range(str, ej, en);
    return strcat(s1, s4, s3, s2, s5);
}

References argv(), argv_end_index, argv_start_index, s1, s2, strcat(), substring_range(), and tokenizebyseparator.

Referenced by _shufflewords_swapfunc().

u8_strsize()

ERASEABLE int u8_strsize

(

string

s

)

Definition at line 378 of file string.qh.

{
    int l = 0;
    for (int i = 0, c; (c = str2chr(s, i)) > 0; ++i, ++l)
    {
        l += (c >= 0x80);
        l += (c >= 0x800);
        l += (c >= 0x10000);
    }
    return l;
}

References str2chr.

Referenced by InputBox_enterText().

unescape()

ERASEABLE string unescape

(

string

in

)

Definition at line 337 of file string.qh.

{
    in = strzone(in);  // but it doesn't seem to be necessary in my tests at least
 
    int len = strlen(in);
    string str = "";
    for (int i = 0; i < len; ++i)
    {
        string s = substring(in, i, 1);
        if (s == "\\")
        {
            s = substring(in, i + 1, 1);
            if (s == "n")
                str = strcat(str, "\n");
            else if (s == "\\")
                str = strcat(str, "\\");
            else
                str = strcat(str, substring(in, i, 2));
            ++i;
            continue;
        }
        str = strcat(str, s);
    }
    strunzone(in);
    return str;
}

References strcat(), strlen, strunzone(), strzone(), and substring().

vercmp()

ERASEABLE int vercmp	(	string	v1,
		string	v2 )

Definition at line 563 of file string.qh.

{
    if (strcasecmp(v1, v2) == 0)
        return 0; // early out check
 
    // "git" beats all
    if (v1 == "git")  return 1;
    if (v2 == "git")  return -1;
 
    return vercmp_recursive(v1, v2);
}

References strcasecmp, and vercmp_recursive().

Referenced by PlayerFrame(), and UpdateNotification_URI_Get_Callback().

vercmp_recursive()

ERASEABLE int vercmp_recursive	(	string	v1,
		string	v2 )

Definition at line 543 of file string.qh.

{
    int dot1 = strstrofs(v1, ".", 0);
    int dot2 = strstrofs(v2, ".", 0);
    string s1 = (dot1 == -1) ? v1 : substring(v1, 0, dot1);
    string s2 = (dot2 == -1) ? v2 : substring(v2, 0, dot2);
 
    float r = stof(s1) - stof(s2);
    if (r != 0)
        return r;
    r = strcasecmp(s1, s2);
    if (r != 0)
        return r;
 
    if (dot1 == -1)
        return (dot2 == -1) ? 0 : -1;
    return (dot2 == -1) ? 1 : vercmp_recursive(substring(v1, dot1 + 1, 999), substring(v2, dot2 + 1, 999));
}

References s1, s2, stof(), strcasecmp, strstrofs, substring(), and vercmp_recursive().

Referenced by vercmp(), and vercmp_recursive().

Variable Documentation

_endsWith_suffix

noref string _endsWith_suffix

Definition at line 242 of file string.qh.

_shufflewords_str

string _shufflewords_str

Definition at line 318 of file string.qh.

Referenced by _shufflewords_swapfunc(), and shufflewords().

autocvar_hud_colorset_background

string autocvar_hud_colorset_background = "7"

BG - White : neutral/unimportant text.

Definition at line 211 of file string.qh.

Referenced by CCR().

autocvar_hud_colorset_foreground_1

string autocvar_hud_colorset_foreground_1 = "2"

F1 - Green : primary priority (important names, etc).

Definition at line 202 of file string.qh.

Referenced by CCR().

autocvar_hud_colorset_foreground_2

string autocvar_hud_colorset_foreground_2 = "3"

F2 - Yellow : secondary priority (items, locations, numbers, etc).

Definition at line 203 of file string.qh.

Referenced by CCR().

autocvar_hud_colorset_foreground_3

string autocvar_hud_colorset_foreground_3 = "4"

F3 - Blue : tertiary priority or relatively inconsequential text.

Definition at line 204 of file string.qh.

Referenced by CCR().

autocvar_hud_colorset_foreground_4

string autocvar_hud_colorset_foreground_4 = "1"

F4 - Red : notice/attention grabbing texting.

Definition at line 205 of file string.qh.

Referenced by CCR().

autocvar_hud_colorset_kill_1

string autocvar_hud_colorset_kill_1 = "1"

K1 - Red : "bad" or "dangerous" text (death messages against you, kill notifications, etc).

Definition at line 207 of file string.qh.

Referenced by CCR().

autocvar_hud_colorset_kill_2

string autocvar_hud_colorset_kill_2 = "3"

K2 - Yellow : similar to above, but less important... OR, a highlight out of above message type.

Definition at line 208 of file string.qh.

Referenced by CCR().

autocvar_hud_colorset_kill_3

string autocvar_hud_colorset_kill_3 = "4"

K3 - Blue : "good" or "beneficial" text (you fragging someone, etc).

Definition at line 209 of file string.qh.

Referenced by CCR().

ColorTranslateMode

int ColorTranslateMode

Definition at line 191 of file string.qh.

Referenced by ColorTranslateRGB(), and CSQC_UpdateView().

DIGITS

const string DIGITS = "0123456789"

Definition at line 582 of file string.qh.

HEXDIGITS

const string HEXDIGITS = "0123456789ABCDEF0123456789abcdef"

Definition at line 576 of file string.qh.

HEXDIGITS_MINSET

const string HEXDIGITS_MINSET = "0123456789ABCDEFabcdef"

Definition at line 575 of file string.qh.