settings.cpp File Reference

settings command More...

#include "pch.h"

Functions
VOID	CommandSettingsHelp ()
	help of the settings command
BOOLEAN	CommandSettingsGetValueFromConfigFile (std::string OptionName, std::string &OptionValue)
	Gets the setting values from config file.
VOID	CommandSettingsSetValueFromConfigFile (std::string OptionName, std::string OptionValue)
	Sets the setting values from config file.
VOID	CommandSettingsLoadDefaultValuesFromConfigFile ()
	Loads default settings values from config file.
VOID	CommandSettingsAddressConversion (vector< string > SplitCommand)
	set the address conversion enabled and disabled and query the status of this mode
VOID	CommandSettingsAutoFlush (vector< string > SplitCommand)
	set the auto-flush mode to enabled and disabled and query the status of this mode
VOID	CommandSettingsAutoUpause (vector< string > SplitCommand)
	set auto-unpause mode to enabled or disabled
VOID	CommandSettingsSyntax (vector< string > SplitCommand)
	set the syntax of !u !u2 u u2 command
VOID	CommandSettings (vector< string > SplitCommand, string Command)
	settings command handler

Variables
BOOLEAN	g_AutoUnpause
	Whether auto-unpause mode is enabled or not enabled.
BOOLEAN	g_AutoFlush
	Whether auto-flush mode is enabled or not enabled.
BOOLEAN	g_AddressConversion
	Whether converting addresses to object names or not.
BOOLEAN	g_IsConnectedToRemoteDebuggee
	Shows whether the current debugger is the host and connected to a remote debuggee (guest)
UINT32	g_DisassemblerSyntax
	Shows the syntax used in !u !u2 u u2 commands.

Detailed Description

settings command

Author

Sina Karvandi (sina@.nosp@m.hype.nosp@m.rdbg..nosp@m.org)

Version

0.1

Date

2020-08-18

Copyright

This project is released under the GNU Public License v3.

Function Documentation

CommandSettings()

VOID CommandSettings	(	vector< string >	SplitCommand,
		string	Command )

settings command handler

Parameters

SplitCommand
Command

Returns

VOID

{
    if (SplitCommand.size() <= 1)
    {
        ShowMessages("incorrect use of the 'settings'\n\n");
        CommandSettingsHelp();
        return;
    }
 
    //
    // Interpret the field name
    //
    if (!SplitCommand.at(1).compare("autounpause"))
    {
        //
        // Handle it locally
        //
        CommandSettingsAutoUpause(SplitCommand);
    }
    else if (!SplitCommand.at(1).compare("syntax"))
    {
        //
        // If it's a remote debugger then we send it to the remote debugger
        //
        if (g_IsConnectedToRemoteDebuggee)
        {
            RemoteConnectionSendCommand(Command.c_str(), (UINT32)Command.length() + 1);
        }
        else
        {
            //
            // If it's a connection over serial or a local debugging then
            // we handle it locally
            //
            CommandSettingsSyntax(SplitCommand);
        }
    }
    else if (!SplitCommand.at(1).compare("autoflush"))
    {
        //
        // If it's a remote debugger then we send it to the remote debugger
        //
        if (g_IsConnectedToRemoteDebuggee)
        {
            RemoteConnectionSendCommand(Command.c_str(), (UINT32)Command.length() + 1);
        }
        else
        {
            //
            // If it's a connection over serial or a local debugging then
            // we handle it locally
            //
            CommandSettingsAutoFlush(SplitCommand);
        }
    }
    else if (!SplitCommand.at(1).compare("addressconversion"))
    {
        //
        // If it's a remote debugger then we send it to the remote debugger
        //
        if (g_IsConnectedToRemoteDebuggee)
        {
            RemoteConnectionSendCommand(Command.c_str(), (UINT32)Command.length() + 1);
        }
        else
        {
            //
            // If it's a connection over serial or a local debugging then
            // we handle it locally
            //
            CommandSettingsAddressConversion(SplitCommand);
        }
    }
    else
    {
        //
        // optionm not found
        //
        ShowMessages("incorrect use of the 'settings', please use 'help settings' "
                     "for more details\n");
        return;
    }
}

CommandSettingsAddressConversion()

VOID CommandSettingsAddressConversion

(

vector< string >

SplitCommand

)

set the address conversion enabled and disabled and query the status of this mode

Parameters

SplitCommand

Returns

VOID

{
    if (SplitCommand.size() == 2)
    {
        //
        // It's a query
        //
        if (g_AddressConversion)
        {
            ShowMessages("address conversion is enabled\n");
        }
        else
        {
            ShowMessages("address conversion is disabled\n");
        }
    }
    else if (SplitCommand.size() == 3)
    {
        //
        // The user tries to set a value as the autoflush
        //
        if (!SplitCommand.at(2).compare("on"))
        {
            g_AddressConversion = TRUE;
            CommandSettingsSetValueFromConfigFile("AddrConv", "on");
 
            ShowMessages("set address conversion to enabled\n");
        }
        else if (!SplitCommand.at(2).compare("off"))
        {
            g_AddressConversion = FALSE;
            CommandSettingsSetValueFromConfigFile("AddrConv", "off");
 
            ShowMessages("set address conversion to disabled\n");
        }
        else
        {
            //
            // Sth is incorrect
            //
            ShowMessages("incorrect use of the 'settings', please use 'help settings' "
                         "for more details\n");
            return;
        }
    }
    else
    {
        //
        // Sth is incorrect
        //
        ShowMessages("incorrect use of the 'settings', please use 'help settings' "
                     "for more details\n");
        return;
    }
}

CommandSettingsAutoFlush()

VOID CommandSettingsAutoFlush

(

vector< string >

SplitCommand

)

set the auto-flush mode to enabled and disabled and query the status of this mode

Parameters

SplitCommand

Returns

VOID

{
    if (SplitCommand.size() == 2)
    {
        //
        // It's a query
        //
        if (g_AutoFlush)
        {
            ShowMessages("auto-flush is enabled\n");
        }
        else
        {
            ShowMessages("auto-flush is disabled\n");
        }
    }
    else if (SplitCommand.size() == 3)
    {
        //
        // The user tries to set a value as the autoflush
        //
        if (!SplitCommand.at(2).compare("on"))
        {
            g_AutoFlush = TRUE;
            CommandSettingsSetValueFromConfigFile("AutoFlush", "on");
 
            ShowMessages("set auto-flush to enabled\n");
        }
        else if (!SplitCommand.at(2).compare("off"))
        {
            g_AutoFlush = FALSE;
            CommandSettingsSetValueFromConfigFile("AutoFlush", "off");
 
            ShowMessages("set auto-flush to disabled\n");
        }
        else
        {
            //
            // Sth is incorrect
            //
            ShowMessages("incorrect use of the 'settings', please use 'help settings' "
                         "for more details\n");
            return;
        }
    }
    else
    {
        //
        // Sth is incorrect
        //
        ShowMessages("incorrect use of the 'settings', please use 'help settings' "
                     "for more details\n");
        return;
    }
}

CommandSettingsAutoUpause()

VOID CommandSettingsAutoUpause

(

vector< string >

SplitCommand

)

set auto-unpause mode to enabled or disabled

Parameters

SplitCommand

Returns

VOID

{
    if (SplitCommand.size() == 2)
    {
        //
        // It's a query
        //
        if (g_AutoUnpause)
        {
            ShowMessages("auto-unpause is enabled\n");
        }
        else
        {
            ShowMessages("auto-unpause is disabled\n");
        }
    }
    else if (SplitCommand.size() == 3)
    {
        //
        // The user tries to set a value as the autounpause
        //
        if (!SplitCommand.at(2).compare("on"))
        {
            g_AutoUnpause = TRUE;
            CommandSettingsSetValueFromConfigFile("AutoUnpause", "on");
 
            ShowMessages("set auto-unpause to enabled\n");
        }
        else if (!SplitCommand.at(2).compare("off"))
        {
            g_AutoUnpause = FALSE;
            CommandSettingsSetValueFromConfigFile("AutoUnpause", "off");
 
            ShowMessages("set auto-unpause to disabled\n");
        }
        else
        {
            //
            // Sth is incorrect
            //
            ShowMessages("incorrect use of the 'settings', please use 'help settings' "
                         "for more details\n");
            return;
        }
    }
    else
    {
        //
        // Sth is incorrect
        //
        ShowMessages("incorrect use of the 'settings', please use 'help settings' "
                     "for more details\n");
        return;
    }
}

CommandSettingsGetValueFromConfigFile()

BOOLEAN CommandSettingsGetValueFromConfigFile	(	std::string	OptionName,
		std::string &	OptionValue )

Gets the setting values from config file.

Parameters

OptionName
OptionValue

Returns

BOOLEAN Shows if the settings is available or not

{
    inipp::Ini<char> Ini;
    WCHAR            ConfigPath[MAX_PATH] = {0};
    std::string      OptionValueFromFile;
 
    //
    // Get config file path
    //
    GetConfigFilePath(ConfigPath);
 
    if (!IsFileExistW(ConfigPath))
    {
        return FALSE;
    }
 
    //
    // Open the file
    //
    ifstream Is(ConfigPath);
 
    //
    // Read config file
    //
    Ini.parse(Is);
 
    //
    // Show config file
    //
    // Ini.generate(std::cout);
 
    inipp::get_value(Ini.sections["DEFAULT"], OptionName, OptionValueFromFile);
 
    Is.close();
 
    if (!OptionValueFromFile.empty())
    {
        OptionValue = OptionValueFromFile;
        return TRUE;
    }
    else
    {
        return FALSE;
    }
}

CommandSettingsHelp()

VOID CommandSettingsHelp

(

)

help of the settings command

Returns

VOID

{
    ShowMessages(
        "settings : queries, sets, or changes a value for a special settings option.\n\n");
 
    ShowMessages("syntax : \tsettings [OptionName (string)]\n");
    ShowMessages("syntax : \tsettings [OptionName (string)] [Value (hex)]\n");
    ShowMessages("syntax : \tsettings [OptionName (string)] [Value (string)]\n");
    ShowMessages("syntax : \tsettings [OptionName (string)] [on|off]\n");
 
    ShowMessages("\n");
    ShowMessages("\t\te.g : settings autounpause\n");
    ShowMessages("\t\te.g : settings autounpause on\n");
    ShowMessages("\t\te.g : settings autounpause off\n");
    ShowMessages("\t\te.g : settings addressconversion on\n");
    ShowMessages("\t\te.g : settings addressconversion off\n");
    ShowMessages("\t\te.g : settings autoflush on\n");
    ShowMessages("\t\te.g : settings autoflush off\n");
    ShowMessages("\t\te.g : settings syntax intel\n");
    ShowMessages("\t\te.g : settings syntax att\n");
    ShowMessages("\t\te.g : settings syntax masm\n");
}

CommandSettingsLoadDefaultValuesFromConfigFile()

VOID CommandSettingsLoadDefaultValuesFromConfigFile

(

)

Loads default settings values from config file.

Returns

VOID

{
    string OptionValue;
 
    //
    // *** Set default configurations ***
    //
 
    //
    // Set the assembly syntax
    //
    if (CommandSettingsGetValueFromConfigFile("AsmSyntax", OptionValue))
    {
        //
        // The user tries to set a value as the syntax
        //
        if (!OptionValue.compare("intel"))
        {
            g_DisassemblerSyntax = 1;
        }
        else if (!OptionValue.compare("att") ||
                 !OptionValue.compare("at&t"))
        {
            g_DisassemblerSyntax = 2;
        }
        else if (!OptionValue.compare("masm"))
        {
            g_DisassemblerSyntax = 3;
        }
        else
        {
            //
            // Sth is incorrect
            //
            ShowMessages("err, incorrect assembly syntax settings\n");
        }
    }
 
    //
    // Set the auto unpause
    //
    if (CommandSettingsGetValueFromConfigFile("AutoUnpause", OptionValue))
    {
        if (!OptionValue.compare("on"))
        {
            g_AutoUnpause = TRUE;
        }
        else if (!OptionValue.compare("off"))
        {
            g_AutoUnpause = FALSE;
        }
        else
        {
            //
            // Sth is incorrect
            //
            ShowMessages("err, incorrect auto unpause settings\n");
        }
    }
 
    //
    // Set the auto flush
    //
    if (CommandSettingsGetValueFromConfigFile("AutoFlush", OptionValue))
    {
        if (!OptionValue.compare("on"))
        {
            g_AutoFlush = TRUE;
        }
        else if (!OptionValue.compare("off"))
        {
            g_AutoFlush = FALSE;
        }
        else
        {
            //
            // Sth is incorrect
            //
            ShowMessages("err, incorrect auto flush settings\n");
        }
    }
 
    //
    // Set the address conversion
    //
    if (CommandSettingsGetValueFromConfigFile("AddrConv", OptionValue))
    {
        if (!OptionValue.compare("on"))
        {
            g_AddressConversion = TRUE;
        }
        else if (!OptionValue.compare("off"))
        {
            g_AddressConversion = FALSE;
        }
        else
        {
            //
            // Sth is incorrect
            //
            ShowMessages("err, incorrect address conversion settings\n");
        }
    }
}

CommandSettingsSetValueFromConfigFile()

VOID CommandSettingsSetValueFromConfigFile	(	std::string	OptionName,
		std::string	OptionValue )

Sets the setting values from config file.

Parameters

OptionName
OptionValue

Returns

VOID

{
    inipp::Ini<char> Ini;
    WCHAR            ConfigPath[MAX_PATH] = {0};
 
    //
    // Get config file path
    //
    GetConfigFilePath(ConfigPath);
 
    ifstream Is(ConfigPath);
 
    //
    // Read config file
    //
    Ini.parse(Is);
 
    Is.close();
 
    //
    // Save the config
    //
    Ini.sections["DEFAULT"][OptionName] = OptionValue.c_str();
    Ini.interpolate();
 
    //
    // Test, show the config
    //
    // Ini.generate(std::cout);
 
    //
    // Save the config
    //
    ofstream Os(ConfigPath);
 
    Ini.generate(Os);
 
    Os.close();
}

CommandSettingsSyntax()

VOID CommandSettingsSyntax

(

vector< string >

SplitCommand

)

set the syntax of !u !u2 u u2 command

Parameters

SplitCommand

Returns

VOID

{
    if (SplitCommand.size() == 2)
    {
        //
        // It's a query
        //
        if (g_DisassemblerSyntax == 1)
        {
            ShowMessages("disassembler syntax is : intel\n");
        }
        else if (g_DisassemblerSyntax == 2)
        {
            ShowMessages("disassembler syntax is : at&t\n");
        }
        else if (g_DisassemblerSyntax == 3)
        {
            ShowMessages("disassembler syntax is : masm\n");
        }
        else
        {
            ShowMessages("unknown syntax\n");
        }
    }
    else if (SplitCommand.size() == 3)
    {
        //
        // The user tries to set a value as the syntax
        //
        if (!SplitCommand.at(2).compare("intel"))
        {
            g_DisassemblerSyntax = 1;
            CommandSettingsSetValueFromConfigFile("AsmSyntax", "intel");
 
            ShowMessages("set syntax to intel\n");
        }
        else if (!SplitCommand.at(2).compare("att") ||
                 !SplitCommand.at(2).compare("at&t"))
        {
            g_DisassemblerSyntax = 2;
            CommandSettingsSetValueFromConfigFile("AsmSyntax", "att");
 
            ShowMessages("set syntax to at&t\n");
        }
        else if (!SplitCommand.at(2).compare("masm"))
        {
            g_DisassemblerSyntax = 3;
            CommandSettingsSetValueFromConfigFile("AsmSyntax", "masm");
 
            ShowMessages("set syntax to masm\n");
        }
        else
        {
            //
            // Sth is incorrect
            //
            ShowMessages("incorrect use of the 'settings', please use 'help settings' "
                         "for more details\n");
            return;
        }
    }
    else
    {
        //
        // Sth is incorrect
        //
        ShowMessages("incorrect use of the 'settings', please use 'help settings' "
                     "for more details\n");
        return;
    }
}

Variable Documentation

g_AddressConversion

BOOLEAN g_AddressConversion

extern

Whether converting addresses to object names or not.

it is enabled by default

g_AutoFlush

BOOLEAN g_AutoFlush

extern

Whether auto-flush mode is enabled or not enabled.

it is disabled by default

g_AutoUnpause

BOOLEAN g_AutoUnpause

extern

Whether auto-unpause mode is enabled or not enabled.

it is enabled by default

g_DisassemblerSyntax

UINT32 g_DisassemblerSyntax

extern

Shows the syntax used in !u !u2 u u2 commands.

INTEL = 1, ATT = 2, MASM = 3

g_IsConnectedToRemoteDebuggee

BOOLEAN g_IsConnectedToRemoteDebuggee

extern

Shows whether the current debugger is the host and connected to a remote debuggee (guest)