cvarlist.qc File Reference

#include "cvarlist.qh"
#include "inputbox.qh"
#include "../item/checkbox.qh"
#include "../item/container.qh"

Include dependency graph for cvarlist.qc:

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

Go to the source code of this file.

Functions
void	CvarList_End_Editing (entity box, entity me)
void	CvarList_Filter_Change (entity box, entity me)
void	CvarList_Filter_Descriptions (entity box, entity me)
void	CvarList_Filter_ModifiedCvars (entity box, entity me)
void	CvarList_Load (entity me, string filter)
void	CvarList_Revert_Click (entity btn, entity me)
void	CvarList_UpdateResults (entity me)
void	CvarList_Value_Change (entity box, entity me)
entity	makeXonoticCvarList ()
void	XonoticCvarList_configureXonoticCvarList (entity me)
void	XonoticCvarList_destroy (entity me)
void	XonoticCvarList_drawListBoxItem (entity me, int i, vector absSize, bool isSelected, bool isFocused)
void	XonoticCvarList_hideNotify (entity me)
float	XonoticCvarList_keyDown (entity me, float scan, float ascii, float shift)
float	XonoticCvarList_mouseRelease (entity me, vector pos)
void	XonoticCvarList_resizeNotify (entity me, vector relOrigin, vector relSize, vector absOrigin, vector absSize)
void	XonoticCvarList_setSelected (entity me, float i)
void	XonoticCvarList_showNotify (entity me)
bool	XonoticCvarList_updateCvarType (entity me)

Variables
string	autocvar_menu_forced_saved_cvars
string	autocvar_menu_reverted_nonsaved_cvars

Function Documentation

CvarList_End_Editing()

void CvarList_End_Editing	(	entity	box,
		entity	me )

Definition at line 314 of file cvarlist.qc.

{
    if (!box.disabled)
        box.parent.setFocus(box.parent, me);
}

References entity().

Referenced by XonoticCvarList::ATTRIB(), and XonoticCvarsDialog_fill().

CvarList_Filter_Change()

void CvarList_Filter_Change	(	entity	box,
		entity	me )

Definition at line 180 of file cvarlist.qc.

{
    CvarList_Load(me, box.text);
    me.setSelected(me, 0);
}

References CvarList_Load(), and entity().

Referenced by XonoticCvarList::ATTRIB(), and XonoticCvarsDialog_fill().

CvarList_Filter_Descriptions()

void CvarList_Filter_Descriptions	(	entity	box,
		entity	me )

Definition at line 192 of file cvarlist.qc.

{
    cvar_set("menu_cvarlist_descriptions", ftos(!autocvar_menu_cvarlist_descriptions));
    box.setChecked(box, autocvar_menu_cvarlist_descriptions);
    CvarList_Load(me, me.controlledTextbox.text);
    me.setSelected(me, 0);
}

References autocvar_menu_cvarlist_descriptions, cvar_set(), CvarList_Load(), entity(), and ftos().

Referenced by XonoticCvarList::ATTRIB(), and XonoticCvarsDialog_fill().

CvarList_Filter_ModifiedCvars()

void CvarList_Filter_ModifiedCvars	(	entity	box,
		entity	me )

Definition at line 185 of file cvarlist.qc.

{
    cvar_set("menu_cvarlist_onlymodified", ftos(!autocvar_menu_cvarlist_onlymodified));
    box.setChecked(box, autocvar_menu_cvarlist_onlymodified);
    CvarList_Load(me, me.controlledTextbox.text);
    me.setSelected(me, 0);
}

References autocvar_menu_cvarlist_onlymodified, cvar_set(), CvarList_Load(), entity(), and ftos().

Referenced by XonoticCvarList::ATTRIB(), and XonoticCvarsDialog_fill().

CvarList_Load()

void CvarList_Load	(	entity	me,
		string	filter )

Definition at line 27 of file cvarlist.qc.

{
    if(me.handle < 0)
        return;
 
    // buf_cvarlist and matchpattern(..., MATCH_AUTO) filtering works in this way:
    //   *aa* finds aa anywhere in the cvar name
    //   *aa finds aa in the end of the cvar name
    //   aa* finds aa in the beginning of the cvar name
    //   aa finds aa in the beginning of the cvar name (not anywhere!)
    // The last case is not very intuitive so here we make it work like *aa*
    // and make it behave like the apropos command
    // Filter, cvar names and cvar descriptions are changed to lowercase to simulate a
    // case insensitive search, like the apropos command
    // Unlike the apropos command, hidden cvars starting with _ are  filtered out
    if (filter == "*") // work around weird case where * doesn't list any cvar
        filter = "";
    else if (filter != "")
    {
        bool ispattern = ((strstrofs(filter, "*", 0) >= 0) || (strstrofs(filter, "?", 0) >= 0));
        filter = strtolower(filter);
        if (!ispattern)
            filter = strcat("*", filter, "*");
    }
 
    if (!autocvar_menu_cvarlist_onlymodified
        && (!autocvar_menu_cvarlist_descriptions || filter == ""))
    {
        // simplest case where we filter only cvar names (or no filter at all)
        buf_cvarlist(me.handle, filter, "_"); // exclude hidden cvars starting with "_"
        me.nItems = buf_getsize(me.handle);
        CvarList_UpdateResults(me);
        return;
    }
 
    // get the complete cvar list
    buf_cvarlist(me.handle, "", "_"); // exclude hidden cvars starting with "_"
    me.nItems = buf_getsize(me.handle);
 
    // filter
    float newbuf = buf_create();
    for (int i = 0; i < me.nItems; ++i)
    {
        string cvar_name = bufstr_get(me.handle, i);
        if (autocvar_menu_cvarlist_onlymodified && cvar_string(cvar_name) == cvar_defstring(cvar_name))
        {
            continue;
        }
        if (filter != "" && !matchpattern(strtolower(cvar_name), filter, MATCH_AUTO)
            && (!autocvar_menu_cvarlist_descriptions
                || !matchpattern(strtolower(cvar_description(cvar_name)), filter, MATCH_AUTO)))
        {
            continue;
        }
        bufstr_add(newbuf, cvar_name, false);
    }
    buf_del(me.handle);
    me.handle = newbuf;
    me.nItems = buf_getsize(me.handle);
    CvarList_UpdateResults(me);
}

References autocvar_menu_cvarlist_descriptions, autocvar_menu_cvarlist_onlymodified, buf_create, cvar_defstring(), cvar_string(), CvarList_UpdateResults(), entity(), MATCH_AUTO, strcat(), strstrofs, and strtolower().

Referenced by CvarList_Filter_Change(), CvarList_Filter_Descriptions(), CvarList_Filter_ModifiedCvars(), and XonoticCvarList_showNotify().

CvarList_Revert_Click()

void CvarList_Revert_Click	(	entity	btn,
		entity	me )

Definition at line 299 of file cvarlist.qc.

{
    me.cvarValueBox.setText(me.cvarValueBox, me.cvarDefault);
    me.cvarValueBox.cursorPos = strlen(me.cvarDefault);
    if(strhasword(autocvar_menu_forced_saved_cvars, me.cvarName))
    {
        cvar_set("menu_forced_saved_cvars", substring(strreplace(strcat(" ", me.cvarName, " "), " ", strcat(" ", autocvar_menu_forced_saved_cvars, " ")), 1, -2));
        if (autocvar_menu_reverted_nonsaved_cvars == "")
            cvar_set("menu_reverted_nonsaved_cvars", me.cvarName);
        else
            cvar_set("menu_reverted_nonsaved_cvars", strcat(autocvar_menu_reverted_nonsaved_cvars, " ", me.cvarName));
    }
    me.cvarNeedsForcing = me.updateCvarType(me);
}

References autocvar_menu_forced_saved_cvars, autocvar_menu_reverted_nonsaved_cvars, cvar_set(), entity(), strcat(), strhasword, strlen, and substring().

Referenced by XonoticCvarList::ATTRIB(), XonoticCvarList_keyDown(), and XonoticCvarsDialog_fill().

CvarList_UpdateResults()

void CvarList_UpdateResults

(

entity

me

)

Definition at line 20 of file cvarlist.qc.

{
    int c = me.nItems;
    static string cvarlistResultCount = string_null;
    strcpy(cvarlistResultCount, c == 1 ? _("1 result") : sprintf(_("%d results"), c));
    me.cvarlistResultCountBox.setText(me.cvarlistResultCountBox, cvarlistResultCount);
}

References entity(), strcpy, and string_null.

Referenced by CvarList_Load().

CvarList_Value_Change()

void CvarList_Value_Change	(	entity	box,
		entity	me )

Definition at line 281 of file cvarlist.qc.

{
    if (box.disabled)
        return;
    cvar_set(me.cvarNameBox.text, box.text);
    if(me.cvarNeedsForcing)
    {
        localcmd(sprintf("\nseta %1$s \"$%1$s\"\n", me.cvarName));
        cvar_set("menu_reverted_nonsaved_cvars", substring(strreplace(strcat(" ", me.cvarName, " "), " ", strcat(" ", autocvar_menu_reverted_nonsaved_cvars, " ")), 1, -2));
        if (autocvar_menu_forced_saved_cvars == "")
            cvar_set("menu_forced_saved_cvars", me.cvarName);
        else
            cvar_set("menu_forced_saved_cvars", strcat(autocvar_menu_forced_saved_cvars, " ", me.cvarName));
        me.cvarNeedsForcing = false;
        me.updateCvarType(me);
    }
}

References autocvar_menu_forced_saved_cvars, autocvar_menu_reverted_nonsaved_cvars, cvar_set(), entity(), localcmd(), strcat(), and substring().

Referenced by XonoticCvarList::ATTRIB(), and XonoticCvarsDialog_fill().

makeXonoticCvarList()

entity makeXonoticCvarList

(

)

Definition at line 8 of file cvarlist.qc.

{
    entity me = NEW(XonoticCvarList);
    me.configureXonoticCvarList(me);
    return me;
}

References entity(), and NEW.

Referenced by XonoticCvarList::ATTRIB(), and XonoticCvarsDialog_fill().

XonoticCvarList_configureXonoticCvarList()

void XonoticCvarList_configureXonoticCvarList

(

entity

me

)

Definition at line 14 of file cvarlist.qc.

{
    me.configureXonoticListBox(me);
    me.handle = buf_create();
    me.nItems = 0;
}

References buf_create, and entity().

XonoticCvarList_destroy()

void XonoticCvarList_destroy

(

entity

me

)

Definition at line 104 of file cvarlist.qc.

{
    if(me.handle)
        buf_del(me.handle);
}

References entity().

XonoticCvarList_drawListBoxItem()

void XonoticCvarList_drawListBoxItem	(	entity	me,
		int	i,
		vector	absSize,
		bool	isSelected,
		bool	isFocused )

Definition at line 212 of file cvarlist.qc.

{
    string k, v, d;
    float t;
 
    vector theColor;
    float theAlpha;
 
    string s;
 
    if(isSelected)
        draw_Fill('0 0 0', '1 1 0', SKINCOLOR_LISTBOX_SELECTED, SKINALPHA_LISTBOX_SELECTED);
    else if(isFocused)
    {
        me.focusedItemAlpha = getFadedAlpha(me.focusedItemAlpha, SKINALPHA_LISTBOX_FOCUSED, SKINFADEALPHA_LISTBOX_FOCUSED);
        draw_Fill('0 0 0', '1 1 0', SKINCOLOR_LISTBOX_FOCUSED, me.focusedItemAlpha);
    }
 
    k = bufstr_get(me.handle, i);
 
    v = cvar_string(k);
    d = cvar_defstring(k);
    t = cvar_type(k);
    if(strhasword(autocvar_menu_forced_saved_cvars, k))
        theAlpha = SKINALPHA_CVARLIST_SAVED;
    else if(strhasword(autocvar_menu_reverted_nonsaved_cvars, k))
        theAlpha = SKINALPHA_CVARLIST_TEMPORARY;
    else if(t & CVAR_TYPEFLAG_SAVED)
        theAlpha = SKINALPHA_CVARLIST_SAVED;
    else
        theAlpha = SKINALPHA_CVARLIST_TEMPORARY;
    if(v == d)
        theColor = SKINCOLOR_CVARLIST_UNCHANGED;
    else
        theColor = SKINCOLOR_CVARLIST_CHANGED;
 
    s = draw_TextShortenToWidth(k, me.columnNameSize, 0, me.realFontSize);
    draw_Text(me.realUpperMargin * eY + me.columnNameOrigin * eX, s, me.realFontSize, theColor, theAlpha, 0);
    s = draw_TextShortenToWidth(v, me.columnValueSize, 0, me.realFontSize);
    draw_Text(me.realUpperMargin * eY + me.columnValueOrigin * eX, s, me.realFontSize, theColor, theAlpha, 0);
}

References autocvar_menu_forced_saved_cvars, autocvar_menu_reverted_nonsaved_cvars, cvar_defstring(), cvar_string(), CVAR_TYPEFLAG_SAVED, draw_Fill(), draw_Text(), draw_TextShortenToWidth(), entity(), eX, eY, getFadedAlpha(), strhasword, and vector.

XonoticCvarList_hideNotify()

void XonoticCvarList_hideNotify

(

entity

me

)

Definition at line 97 of file cvarlist.qc.

{
    if(me.handle)
        buf_del(me.handle);
    me.handle = buf_create();
    me.nItems = 0;
}

References buf_create, and entity().

XonoticCvarList_keyDown()

float XonoticCvarList_keyDown	(	entity	me,
		float	scan,
		float	ascii,
		float	shift )

Definition at line 254 of file cvarlist.qc.

{
    if (!me.cvarValueBox.disabled && (scan == K_MOUSE3 || ((shift & S_CTRL) && scan == K_SPACE)))
    {
        CvarList_Revert_Click(NULL, me);
        return 1;
    }
    else if(!me.cvarValueBox.disabled && scan == K_ENTER)
    {
        me.cvarValueBox.parent.setFocus(me.cvarValueBox.parent, me.cvarValueBox);
        return 1;
    }
    else if(SUPER(XonoticCvarList).keyDown(me, scan, ascii, shift))
        return 1;
    else if(!me.controlledTextbox || me.cvarValueBox.disabled)
        return 0;
    else
        return me.controlledTextbox.keyDown(me.controlledTextbox, scan, ascii, shift);
}

References CvarList_Revert_Click(), entity(), K_ENTER, K_MOUSE3, K_SPACE, NULL, S_CTRL, and SUPER.

XonoticCvarList_mouseRelease()

float XonoticCvarList_mouseRelease	(	entity	me,
		vector	pos )

Definition at line 274 of file cvarlist.qc.

{
    if (!me.cvarValueBox.disabled && me.pressed == 2)
        me.cvarValueBox.parent.setFocus(me.cvarValueBox.parent, me.cvarValueBox);
    return SUPER(XonoticCvarList).mouseRelease(me, pos);
}

References entity(), SUPER, and vector.

XonoticCvarList_resizeNotify()

void XonoticCvarList_resizeNotify	(	entity	me,
		vector	relOrigin,
		vector	relSize,
		vector	absOrigin,
		vector	absSize )

Definition at line 199 of file cvarlist.qc.

{
    SUPER(XonoticCvarList).resizeNotify(me, relOrigin, relSize, absOrigin, absSize);
 
    me.realFontSize_y = me.fontSize / (absSize.y * me.itemHeight);
    me.realFontSize_x = me.fontSize / (absSize.x * (1 - me.controlWidth));
    me.realUpperMargin = 0.5 * (1 - me.realFontSize.y);
 
    me.columnNameOrigin = 0;
    me.columnValueSize = me.realFontSize.x * 20;
    me.columnNameSize = 1 - me.columnValueSize - me.realFontSize.x;
    me.columnValueOrigin = me.columnNameOrigin + me.columnNameSize + me.realFontSize.x;
}

References entity(), SUPER, and vector.

XonoticCvarList_setSelected()

void XonoticCvarList_setSelected	(	entity	me,
		float	i )

Definition at line 156 of file cvarlist.qc.

{
    string s;
 
    SUPER(XonoticCvarList).setSelected(me, i);
    if(me.nItems == 0)
        return;
 
    strfree(me.cvarType);
    strcpy(me.cvarName, bufstr_get(me.handle, me.selectedItem));
    strcpy(me.cvarDescription, cvar_description(me.cvarName));
    strcpy(me.cvarDefault, cvar_defstring(me.cvarName));
    me.cvarNameBox.setText(me.cvarNameBox, me.cvarName);
    me.cvarDescriptionBox.setText(me.cvarDescriptionBox, me.cvarDescription);
    bool needsForcing = me.updateCvarType(me);
    me.cvarDefaultBox.setText(me.cvarDefaultBox, me.cvarDefault);
 
    // this one can handle tempstrings
    s = cvar_string(me.cvarName);
    me.cvarNeedsForcing = false;
    me.cvarValueBox.setText(me.cvarValueBox, s);
    me.cvarNeedsForcing = needsForcing;
    me.cvarValueBox.cursorPos = strlen(s);
}

References cvar_defstring(), cvar_string(), entity(), strcpy, strfree, strlen, and SUPER.

XonoticCvarList_showNotify()

void XonoticCvarList_showNotify

(

entity

me

)

Definition at line 88 of file cvarlist.qc.

{
    bool force_initial_selection = false;
    if(me.handle >= 0 && me.nItems <= 0) // me.handle not loaded yet?
        force_initial_selection = true;
    CvarList_Load(me, me.controlledTextbox.text);
    if(force_initial_selection)
        me.setSelected(me, 0);
}

References CvarList_Load(), and entity().

XonoticCvarList_updateCvarType()

bool XonoticCvarList_updateCvarType

(

entity

me

)

Definition at line 111 of file cvarlist.qc.

{
    float t = cvar_type(me.cvarName);
    me.cvarType = "";
    bool needsForcing;
    if(strhasword(autocvar_menu_forced_saved_cvars, me.cvarName))
    {
        me.cvarType = strcat(me.cvarType, ", ", _("forced to be saved to config.cfg"));
        needsForcing = false;
    }
    else if(strhasword(autocvar_menu_reverted_nonsaved_cvars, me.cvarName))
    {
        // Currently claims to be saved, but won't be on next startup.
        me.cvarType = strcat(me.cvarType, ", ", _("will not be saved"));
        needsForcing = true;
    }
    else if(t & CVAR_TYPEFLAG_SAVED)
    {
        me.cvarType = strcat(me.cvarType, ", ", _("will be saved to config.cfg"));
        needsForcing = false;
    }
    else
    {
        me.cvarType = strcat(me.cvarType, ", ", _("will not be saved"));
        needsForcing = true;
    }
    if(t & CVAR_TYPEFLAG_PRIVATE)
        me.cvarType = strcat(me.cvarType, ", ", _("private"));
    if(t & CVAR_TYPEFLAG_ENGINE)
        me.cvarType = strcat(me.cvarType, ", ", _("engine setting"));
    if(t & CVAR_TYPEFLAG_READONLY)
    {
        me.cvarType = strcat(me.cvarType, ", ", _("read only"));
        me.cvarValueBox.disabled = true;
        me.cvarDefaultBox.disabled = true;
    }
    else
    {
        me.cvarValueBox.disabled = false;
        me.cvarDefaultBox.disabled = false;
    }
    me.cvarType = strzone(substring(me.cvarType, 2, strlen(me.cvarType) - 2));
    me.cvarTypeBox.setText(me.cvarTypeBox, me.cvarType);
    return needsForcing;
}

References autocvar_menu_forced_saved_cvars, autocvar_menu_reverted_nonsaved_cvars, CVAR_TYPEFLAG_ENGINE, CVAR_TYPEFLAG_PRIVATE, CVAR_TYPEFLAG_READONLY, CVAR_TYPEFLAG_SAVED, entity(), strcat(), strhasword, strlen, strzone(), and substring().

Variable Documentation

autocvar_menu_forced_saved_cvars

string autocvar_menu_forced_saved_cvars

Definition at line 109 of file cvarlist.qc.

Referenced by CvarList_Revert_Click(), CvarList_Value_Change(), XonoticCvarList_drawListBoxItem(), and XonoticCvarList_updateCvarType().

autocvar_menu_reverted_nonsaved_cvars

string autocvar_menu_reverted_nonsaved_cvars

Definition at line 110 of file cvarlist.qc.

Referenced by CvarList_Revert_Click(), CvarList_Value_Change(), XonoticCvarList_drawListBoxItem(), and XonoticCvarList_updateCvarType().