This class implements an interface of the internal Settings object adapted to be usable from the GUI. More...

#include <Options.h>

Inheritance diagram for Options:

Collaboration diagram for Options:

Public Types
enum	Styles { STANDARD , CONSOLE_STD , COMMAND , COMMENT , DOCCOMMENT , DOCKEYWORD , OPTION , FUNCTION , CUSTOM_FUNCTION , CLUSTER , CONSTANT , SPECIALVAL , STRING , STRINGPARSER , INCLUDES , OPERATOR , PROCEDURE , NUMBER , PROCEDURE_COMMAND , METHODS , INSTALL , DEFAULT_VARS , ACTIVE_LINE , STYLE_END }
	An enumeration of all available syntax styles. More...

enum	AnalyzerOptions { USE_NOTES , USE_WARNINGS , USE_ERRORS , COMMENT_DENSITY , LINES_OF_CODE , COMPLEXITY , MAGIC_NUMBERS , ALWAYS_SHOW_METRICS , INLINE_IF , CONSTANT_EXPRESSION , RESULT_SUPPRESSION , RESULT_ASSIGNMENT , TYPE_ORIENTATION , MISLEADING_TYPE , ARGUMENT_UNDERSCORE , VARIABLE_LENGTH , UNUSED_VARIABLES , PROCEDURE_LENGTH , THISFILE_NAMESPACE , PROGRESS_RUNTIME , SWITCH_FALLTHROUGH , GLOBAL_VARIABLES , ANALYZER_OPTIONS_END }
	An enumeration of all available static analyzer options. More...

Public Member Functions
	Options ()

	~Options ()

void	SetEditorFont (wxFont font)

void	SetPrintStyle (int style)

void	SetTerminalHistorySize (int size)

void	SetShowToolbarText (bool useText)

void	SetShowPathOnTabs (bool useText)

void	SetLineNumberPrinting (bool printLineNumbers)

void	SetSaveSession (bool saveSession)

void	SetSaveBookmarksInSession (bool save)

void	SetFormatBeforeSaving (bool formatBeforeSave)

void	SetLaTeXRoot (const wxString &root)

void	SetKeepBackupFile (bool keepFile)

void	SetCaretBlinkTime (int nTime)

void	SetDebuggerFocusLine (int nLine)

void	SetShowLinesInStackTrace (bool show)

void	SetShowModulesInStackTrace (bool show)

void	SetShowProcedureArguments (bool show)

void	SetShowGlobalVariables (bool show)

void	SetFoldDuringLoading (bool fold)

void	SetHighlightLocalVariables (bool highlight)

wxFont	GetEditorFont () const

int	GetPrintStyle () const

wxString	GetLaTeXRoot () const

bool	GetShowToolbarText () const

bool	GetShowPathOnTabs () const

bool	GetLineNumberPrinting () const

bool	GetSaveSession () const

bool	GetSaveBookmarksInSession () const

bool	GetFormatBeforeSaving () const

bool	GetKeepBackupFile () const

int	GetTerminalHistorySize () const

int	GetCaretBlinkTime () const

int	GetDebuggerFocusLine () const

bool	GetShowLinesInStackTrace () const

bool	GetShowModulesInStackTrace () const

bool	GetShowProcedureArguments () const

bool	GetShowGlobalVariables () const

bool	GetFoldDuringLoading () const

bool	GetHighlightLocalVariables () const

SyntaxStyles	GetDefaultSyntaxStyle (size_t i) const
	Return the default syntax style as defined by the programmers. More...

SyntaxStyles	GetSyntaxStyle (size_t i) const
	Return the selected syntax style by constructing it from the style string. More...

void	SetSyntaxStyle (size_t i, const SyntaxStyles &styles)
	Update a selected syntax style by converting the passed SyntaxStyles object into a style string and storing it internally. More...

void	SetAnalyzerOption (AnalyzerOptions opt, int nVal)
	Change a static code analyzer setting. More...

int	GetAnalyzerOption (AnalyzerOptions opt) const
	Return the value of the selected static code analyzer option. More...

void	readColoursFromConfig (wxFileConfig *_config)
	Legacy syntax style import function from file configuration. More...

void	readAnalyzerOptionsFromConfig (wxFileConfig *_config)
	Legacy analyzer import function from file configuration. More...

wxArrayString	GetStyleIdentifier () const
	This member function returns an array of the style enumeration identifiers converted to a string. More...

size_t	GetIdByIdentifier (const wxString &identifier) const
	This member function returns the ID of a syntax style by passing the style identifier as a string. More...

Public Member Functions inherited from Settings
	Settings ()
	Settings class default constructor. Creates and fills the internal setting value map with their default values. More...

	Settings (const Settings &_settings)
	Settings class copy constructor. Delegates the initialization to the default constructor. More...

void	copySettings (const Settings &_settings)
	This member function is an alias for the assignment operator overload. More...

Settings &	operator= (const Settings &_settings)
	Assignment operator overload. More...

void	save (const std::string &_sWhere, bool bMkBackUp=false)
	Saves the setting values to the corresponding config file. Does only save the setting values, which are marked that they shall be saved. More...

void	load (const std::string &_sWhere)
	Opens the configuration file, identifies its version and imports the setting values. More...

SettingsValue &	getSetting (const std::string &value)
	Returns a reference to the setting value, which corresponds to the passed string. Throws an exception, if the setting does not exist. More...

const SettingsValue &	getSetting (const std::string &value) const
	Returns a const reference to the setting value, which corresponds to the passed string. Throws an exception, if the setting does not exist. More...

std::map< std::string, SettingsValue > &	getSettings ()
	Returns a reference to the internal map of setting values. More...

const std::map< std::string, SettingsValue > &	getSettings () const
	Returns a const reference to the internal map of setting values. More...

void	enable (const std::string &option)
	Enables a setting with boolean value type. If the setting does not have this type, nothing happens. More...

void	disable (const std::string &option)
	Disables a setting with boolean value type. If the setting does not have this type, nothing happens. More...

bool	isEnabled (const std::string &option) const
	Returns true, if the setting with boolean value type is enabled, false otherwise. If the setting does not have a boolean value type, this method will return false as well. More...

void	enableSystemPrints (bool _bSystemPrints=true)
	Enables or disables the system printing functionality. This is a convenience wrapper for the direct map access. More...

void	setDefaultPlotFont (const std::string &plotFont)
	Update the default plotting font. This member function evaluates first, whether the selected font actually exists. More...

bool	isDeveloperMode () const
	Returns, whether the developer mode is currently enabled. More...

bool	isDraftMode () const
	Returns, whether the plotting draft mode is enabled. More...

bool	createCompactTables () const
	Returns, whether tables shall be displayed in a more compact way (does nothing in the external table viewer). More...

bool	showGreeting () const
	Returns, whether NumeRe shall greet the user with a funny message at application start-up. More...

bool	showHints () const
	Returns, whether the tip-of-the-day shall be displayed to the user at application start-up. More...

bool	useEscInScripts () const
	Returns, whether ESC key presses shall be handled, when scripts are being executed. More...

bool	controlDefinitions () const
	Returns, whether NumeRe shall load and save custom functions automatically. More...

bool	showExtendedFileInfo () const
	Returns, whether the file tree or the terminal file explorer shall display extended file information for NumeRe data files. More...

bool	useLogFile () const
	Returns, whether the terminal inputs shall be protocoled in a dedicated logfile. This setting does not modify the history functionality. More...

bool	loadEmptyCols () const
	Returns, whether NumeRe shall keep empty columns when loading a file to memory. More...

size_t	getPrecision () const
	Returns the precision for displaying floating numbers in the terminal. This value determines the number of valid numbers, which shall be displayed. More...

std::string	getExePath () const
	Returns the current application root folder path. More...

std::string	getWorkPath () const
	Returns the current working path (connected to the <wp> token). More...

std::string	getSavePath () const
	Returns the current saving path. More...

std::string	getLoadPath () const
	Returns the current loading path. More...

std::string	getPlotPath () const
	Returns the current plotting path (plot storing location). More...

std::string	getScriptPath () const
	Returns the current script import folder path. More...

std::string	getProcPath () const
	Returns the current procedure root import path. More...

size_t	getAutoSaveInterval () const
	Returns the timespan for the autosave interval in seconds. More...

size_t	getBuffer () const
	Returns the current terminal buffer size. More...

size_t	getWindow (int nWindow=0) const
	Returns the current window size of the terminal. More...

std::string	getDefaultPlotFont () const
	Returns the current plotting font name. More...

std::string	getTokenPaths () const
	Returns a semicolon-separated list of the current defined path placeholders and their values. More...

bool	systemPrints () const
	Returns, whether system messages shall be printed to the terminal. More...

bool	useDebugger () const
	Returns, whether the debugger is currently active. More...

bool	useCustomLangFiles () const
	Returns, whether user language files shall be used to override internal language strings. More...

bool	useExternalDocWindow () const
	Returns, whether documentations shall be displayed in external windows. More...

bool	executeEnabled () const
	Returns, whether the user enabled the `execute` command. More...

bool	useMaskDefault () const
	Returns, whether loop flow control statements shall use the `mask` option automatically. More...

bool	decodeArguments () const
	Returns, whether the debugger shall try to decode procedure arguments. More...

Public Member Functions inherited from Documentation
	Documentation ()
	The default constructor. More...

	~Documentation ()
	The destructor closes the internal file stream, if it is still open. More...

void	createDocumentationIndex (bool bLoadUserLangFiles=true)
	This member function loads the index files to memory. More...

void	addFileToDocumentationIndex (const std::string &sFileName)
	This member function is used to add documentation index entries to the index during a plugin or package installation. More...

void	removeFromDocIndex (const std::string &_sID)
	This member function removes the index entry passed to the function from the documentation index. More...

std::vector< std::string >	getHelpArticle (const std::string &sTopic)
	This member function returns the documentation article, which corresponds to the passed documentation topic of the the whole documentation index in readable form. More...

std::vector< std::string >	getDocIndex () const
	This member function returns the key list for the documentation index prepared for the corresponding tree in the documentation browser. More...

std::string	getHelpIdxKey (const std::string &sTopic)
	This member function returns an index key, which corresponds to the queried topic. More...

std::string	getHelpArticleID (const std::string &sTopic)
	This member function returns the article ID corresponding to the queried topic. More...

std::string	getHelpArticleTitle (const std::string &_sIdxKey)
	This member function returns the documentation article title corresponding to the queried index key. More...

Public Member Functions inherited from FileSystem
	FileSystem ()
	Default constructor. More...

FileSystem &	assign (const FileSystem &_fSys)
	Assignment member function to copy the settings from another FileSystem instance. More...

std::string	ValidFileName (std::string _sFileName, const std::string sExtension=".dat", bool checkExtension=true, bool doCleanPath=true) const
	This member function evaluates, whether the passed filename is a valid filename. One may supply a preferred filename extension. More...

std::string	ValidFolderName (std::string _sFileName, bool doCleanPath=true, bool appendTrailingSeparator=true) const
	This member function evaluates, whether the passed foldername is a valid foldername. More...

std::string	ValidizeAndPrepareName (const std::string &_sFileName, const std::string &sExtension=".dat") const
	This member function validizes the passed file name and creates the needed folders on-the-fly. More...

int	setPath (std::string _sPath, bool bMkDir, std::string _sExePath)
	This member function may be used to set the preferred file path of the current FileSystem instance. More...

void	createRevisionsFolder ()
	This member function creates the hidden revisions folders for the version control system. More...

std::string	getPath () const
	Returns the default path of this FileSystem instance. More...

std::vector< std::string >	getFileParts (const std::string &sFilePath) const
	This member function separates all path parts into single strings: the drive letter, the path, the name and the extension. This function may also handle folder paths and network paths. More...

FileInfo	getFileInfo (const std::string &sFilePath) const
	Return the file information about the passed file path. More...

void	setTokens (std::string _sTokens)
	This member function may be used to update the path placeholders of the current FileSystem instance. More...

bool	isFile (const std::string &_sPath) const
	This function determines, whether a path name indicates a file or a folder. More...

void	initializeFromKernel ()
	Member function to remote-initialize the class from the kernel. Cannot be used during kernel start-up. More...

void	setProgramPath (std::string _sExePath)

std::string	getProgramPath () const

void	declareFileType (const std::string &sFileType)

Static Public Member Functions
static wxFont	toFont (const std::string &sFontDescr)

static std::string	toString (wxFont font)

Static Public Member Functions inherited from Documentation
static std::string	getArgAtPos (const std::string &sCmd, unsigned int pos)
	This static member is a fallback for the XML-parsing logic-stuff. More...

Private Member Functions
std::string	analyzerOptsToString (AnalyzerOptions opt) const
	Convert the static code analyzer enumeration values into the new settings strings. More...

std::string	syntaxStylesToString (Styles style) const
	Convert the syntax style enumeration values into the new settings strings. More...

Friends
class	OptionsDialog

Additional Inherited Members
Protected Member Functions inherited from FileSystem
int	createFolders (const std::string &_sPath) const
	This member function creates all missing directories in the passed path. More...

Protected Attributes inherited from Settings
std::map< std::string, SettingsValue >	m_settings

Protected Attributes inherited from FileSystem
std::string	sPath

std::string	sExecutablePath

std::string	sTokens [7][2]

std::string	sValidExtensions

Detailed Description

This class implements an interface of the internal Settings object adapted to be usable from the GUI.

Definition at line 177 of file Options.h.

Member Enumeration Documentation

◆ AnalyzerOptions

enum Options::AnalyzerOptions

An enumeration of all available static analyzer options.

Enumerator
USE_NOTES
USE_WARNINGS
USE_ERRORS
COMMENT_DENSITY
LINES_OF_CODE
COMPLEXITY
MAGIC_NUMBERS
ALWAYS_SHOW_METRICS
INLINE_IF
CONSTANT_EXPRESSION
RESULT_SUPPRESSION
RESULT_ASSIGNMENT
TYPE_ORIENTATION
MISLEADING_TYPE
ARGUMENT_UNDERSCORE
VARIABLE_LENGTH
UNUSED_VARIABLES
PROCEDURE_LENGTH
THISFILE_NAMESPACE
PROGRESS_RUNTIME
SWITCH_FALLTHROUGH
GLOBAL_VARIABLES
ANALYZER_OPTIONS_END

Definition at line 308 of file Options.h.

◆ Styles

enum Options::Styles

An enumeration of all available syntax styles.

Enumerator
STANDARD
CONSOLE_STD
COMMAND
COMMENT
DOCCOMMENT
DOCKEYWORD
OPTION
FUNCTION
CUSTOM_FUNCTION
CLUSTER
CONSTANT
SPECIALVAL
STRING
STRINGPARSER
INCLUDES
OPERATOR
PROCEDURE
NUMBER
PROCEDURE_COMMAND
METHODS
INSTALL
DEFAULT_VARS
ACTIVE_LINE
STYLE_END

Definition at line 276 of file Options.h.

Constructor & Destructor Documentation

◆ Options()

Options::Options ( )

Definition at line 12 of file options.cpp.

◆ ~Options()

Options::~Options ( )

Definition at line 16 of file options.cpp.

Member Function Documentation

◆ analyzerOptsToString()

std::string Options::analyzerOptsToString ( AnalyzerOptions opt ) const

private

Convert the static code analyzer enumeration values into the new settings strings.

Parameters

opt	AnalyzerOptions

Returns: std::string

Definition at line 332 of file options.cpp.

References SETTING_B_AN_ALWAYSMETRICS, SETTING_B_AN_COMMENTDENS, SETTING_B_AN_COMPLEXITY, SETTING_B_AN_CONSTANTS, SETTING_B_AN_FALLTHROUGH, SETTING_B_AN_GLOBALVARS, SETTING_B_AN_INLINEIF, SETTING_B_AN_LOC, SETTING_B_AN_MAGICNUMBERS, SETTING_B_AN_MISLEADINGTYPE, SETTING_B_AN_PROCLENGTH, SETTING_B_AN_PROGRESS, SETTING_B_AN_RESULTASS, SETTING_B_AN_RESULTSUP, SETTING_B_AN_THISFILE, SETTING_B_AN_TYPING, SETTING_B_AN_UNDERSCOREARGS, SETTING_B_AN_UNUSEDVARS, SETTING_B_AN_USEERRORS, SETTING_B_AN_USENOTES, SETTING_B_AN_USEWARNINGS, and SETTING_B_AN_VARLENGTH.

Referenced by GetAnalyzerOption(), and SetAnalyzerOption().

◆ GetAnalyzerOption()

int Options::GetAnalyzerOption ( AnalyzerOptions opt ) const

Return the value of the selected static code analyzer option.

Parameters

opt	AnalyzerOptions

Returns: int

Definition at line 256 of file options.cpp.

References analyzerOptsToString(), and Settings::m_settings.

Referenced by CodeAnalyzer::addToAnnotation(), CodeAnalyzer::analyseCommands(), CodeAnalyzer::analyseFunctions(), CodeAnalyzer::analyseIdentifiers(), CodeAnalyzer::analyseNumbers(), OptionsDialog::InitializeDialog(), and CodeAnalyzer::run().

Here is the call graph for this function:

◆ GetCaretBlinkTime()

int Options::GetCaretBlinkTime ( ) const

inline

Definition at line 255 of file Options.h.

References Settings::m_settings, and SETTING_V_CARETBLINKTIME.

Referenced by NumeReWindow::EvaluateOptions(), and NumeReEditor::NumeReEditor().

◆ GetDebuggerFocusLine()

int Options::GetDebuggerFocusLine ( ) const

inline

Definition at line 257 of file Options.h.

References Settings::m_settings, and SETTING_V_FOCUSEDLINE.

Referenced by NumeReEditor::FocusOnLine().

◆ GetDefaultSyntaxStyle()

SyntaxStyles Options::GetDefaultSyntaxStyle ( size_t i ) const

Return the default syntax style as defined by the programmers.

Parameters

i size_t

Returns: SyntaxStyles

Definition at line 45 of file options.cpp.

References DEFAULT_ST_ACTIVELINE, DEFAULT_ST_CLUSTER, DEFAULT_ST_COMMAND, DEFAULT_ST_COMMENT, DEFAULT_ST_CONSOLESTD, DEFAULT_ST_CONSTANT, DEFAULT_ST_CUSTOMFUNC, DEFAULT_ST_DEFVARS, DEFAULT_ST_DOCCOMMENT, DEFAULT_ST_DOCKEYWORD, DEFAULT_ST_FUNCTION, DEFAULT_ST_INCLUDES, DEFAULT_ST_INSTALL, DEFAULT_ST_METHODS, DEFAULT_ST_NUMBER, DEFAULT_ST_OPERATOR, DEFAULT_ST_OPTION, DEFAULT_ST_PROCCOMMAND, DEFAULT_ST_PROCEDURE, DEFAULT_ST_SPECIALVAL, DEFAULT_ST_STANDARD, DEFAULT_ST_STRING, and DEFAULT_ST_STRINGPARSER.

Referenced by OptionsDialog::OnButtonClick().

◆ GetEditorFont()

wxFont Options::GetEditorFont ( ) const

inline

Definition at line 231 of file Options.h.

References Settings::m_settings, SETTING_S_EDITORFONT, and toFont().

Referenced by NumeReEditor::NumeReEditor(), and NumeReWindow::OnOptions().

Here is the call graph for this function:

◆ GetFoldDuringLoading()

bool Options::GetFoldDuringLoading ( ) const

inline

Definition at line 267 of file Options.h.

References Settings::m_settings, and SETTING_B_FOLDLOADEDFILE.

Referenced by NumeReWindow::OpenSourceFile(), and EditorNotebook::split().

◆ GetFormatBeforeSaving()

bool Options::GetFormatBeforeSaving ( ) const

inline

Definition at line 249 of file Options.h.

References Settings::m_settings, and SETTING_B_FORMATBEFORESAVING.

◆ GetHighlightLocalVariables()

bool Options::GetHighlightLocalVariables ( ) const

inline

Definition at line 269 of file Options.h.

References Settings::m_settings, and SETTING_B_HIGHLIGHTLOCALS.

Referenced by NumeReEditor::markLocalVariables().

◆ GetIdByIdentifier()

size_t Options::GetIdByIdentifier ( const wxString & identifier ) const

This member function returns the ID of a syntax style by passing the style identifier as a string.

Parameters

identifier const wxString&

Returns: size_t

Definition at line 315 of file options.cpp.

References GetStyleIdentifier().

Referenced by OptionsDialog::InitializeDialog(), OptionsDialog::OnButtonClick(), OptionsDialog::OnColorPickerChange(), OptionsDialog::OnColorTypeChange(), and OptionsDialog::OnFontCheckClick().

Here is the call graph for this function:

◆ GetKeepBackupFile()

bool Options::GetKeepBackupFile ( ) const

inline

Definition at line 251 of file Options.h.

References Settings::m_settings, and SETTING_B_USEREVISIONS.

Referenced by NumeReWindow::OnFileEventTimer(), and NumeReEditor::SaveFile().

◆ GetLaTeXRoot()

wxString Options::GetLaTeXRoot ( ) const

inline

Definition at line 237 of file Options.h.

References Settings::m_settings, and SETTING_S_LATEXROOT.

Referenced by NumeReWindow::compileLaTeX(), and NumeReWindow::runLaTeX().

◆ GetLineNumberPrinting()

bool Options::GetLineNumberPrinting ( ) const

inline

Definition at line 243 of file Options.h.

References Settings::m_settings, and SETTING_B_PRINTLINENUMBERS.

Referenced by NumeRePrintout::OnBeginDocument().

◆ GetPrintStyle()

int Options::GetPrintStyle ( ) const

inline

Definition at line 235 of file Options.h.

References Settings::m_settings, SETTING_B_PRINTINCOLOR, wxSTC_PRINT_BLACKONWHITE, and wxSTC_PRINT_COLOURONWHITE.

Referenced by OptionsDialog::InitializeDialog(), NumeReWindow::OnPrintPage(), and NumeReWindow::OnPrintPreview().

◆ GetSaveBookmarksInSession()

bool Options::GetSaveBookmarksInSession ( ) const

inline

Definition at line 247 of file Options.h.

References Settings::m_settings, and SETTING_B_SAVEBOOKMARKS.

Referenced by NumeReWindow::CloseAllFiles(), and NumeReWindow::prepareSession().

◆ GetSaveSession()

bool Options::GetSaveSession ( ) const

inline

Definition at line 245 of file Options.h.

References Settings::m_settings, and SETTING_B_SAVESESSION.

Referenced by NumeReWindow::CloseAllFiles(), and NumeReWindow::prepareSession().

◆ GetShowGlobalVariables()

bool Options::GetShowGlobalVariables ( ) const

inline

Definition at line 265 of file Options.h.

References Settings::m_settings, and SETTING_B_GLOBALVARS.

Referenced by DebugViewer::getInformationByStackId(), and VariableViewer::setDebuggerMode().

◆ GetShowLinesInStackTrace()

bool Options::GetShowLinesInStackTrace ( ) const

inline

Definition at line 259 of file Options.h.

References Settings::m_settings, and SETTING_B_LINESINSTACK.

Referenced by DebugViewer::setDebugInfo(), and DebugViewer::updateSettings().

◆ GetShowModulesInStackTrace()

bool Options::GetShowModulesInStackTrace ( ) const

inline

Definition at line 261 of file Options.h.

References Settings::m_settings, and SETTING_B_MODULESINSTACK.

Referenced by DebugViewer::setDebugInfo(), and DebugViewer::updateSettings().

◆ GetShowPathOnTabs()

bool Options::GetShowPathOnTabs ( ) const

inline

Definition at line 241 of file Options.h.

References Settings::m_settings, and SETTING_B_PATHSONTABS.

◆ GetShowProcedureArguments()

bool Options::GetShowProcedureArguments ( ) const

inline

Definition at line 263 of file Options.h.

References Settings::m_settings, and SETTING_B_PROCEDUREARGS.

Referenced by DebugViewer::getInformationByStackId(), and VariableViewer::setDebuggerMode().

◆ GetShowToolbarText()

bool Options::GetShowToolbarText ( ) const

inline

Definition at line 239 of file Options.h.

References Settings::m_settings, and SETTING_B_TOOLBARTEXT.

Referenced by NumeReWindow::UpdateToolbar().

◆ GetStyleIdentifier()

wxArrayString Options::GetStyleIdentifier ( ) const

This member function returns an array of the style enumeration identifiers converted to a string.

Returns: wxArrayString

Definition at line 275 of file options.cpp.

Referenced by OptionsDialog::CreateStylePage(), GetIdByIdentifier(), OptionsDialog::InitializeDialog(), and OptionsDialog::synchronizeColors().

◆ GetSyntaxStyle()

SyntaxStyles Options::GetSyntaxStyle ( size_t i ) const

Return the selected syntax style by constructing it from the style string.

Parameters

i size_t

Returns: SyntaxStyles

Definition at line 112 of file options.cpp.

References Settings::m_settings, and syntaxStylesToString().

Referenced by OptionsDialog::CreateStylePage(), NumeReTerminal::GetDefColors(), OptionsDialog::InitializeDialog(), NumeReEditor::NumeReEditor(), OptionsDialog::OnColorPickerChange(), OptionsDialog::OnColorTypeChange(), OptionsDialog::OnFontCheckClick(), NumeReWindow::OnOptions(), DebugViewer::setExpression(), OptionsDialog::synchronizeColors(), NumeReEditor::updateDefaultHighlightSettings(), NumeReEditor::UpdateSyntaxHighlighting(), and NumeReHistory::UpdateSyntaxHighlighting().

Here is the call graph for this function:

◆ GetTerminalHistorySize()

int Options::GetTerminalHistorySize ( ) const

inline

Definition at line 253 of file Options.h.

References Settings::m_settings, and SETTING_V_BUFFERSIZE.

Referenced by NumeReWindow::EvaluateOptions().

◆ readAnalyzerOptionsFromConfig()

void Options::readAnalyzerOptionsFromConfig ( wxFileConfig * _config )

Legacy analyzer import function from file configuration.

Parameters

_config wxFileConfig*

Returns: void

Definition at line 205 of file options.cpp.

References SetAnalyzerOption(), and StrToInt().

Referenced by NumeReWindow::InitializeProgramOptions().

Here is the call graph for this function:

◆ readColoursFromConfig()

void Options::readColoursFromConfig ( wxFileConfig * _config )

Legacy syntax style import function from file configuration.

Parameters

_config wxFileConfig*

Returns: void

Definition at line 150 of file options.cpp.

References Settings::m_settings, syntaxStylesToString(), and SyntaxStyles::to_string().

Referenced by NumeReWindow::InitializeProgramOptions().

Here is the call graph for this function:

◆ SetAnalyzerOption()

void Options::SetAnalyzerOption	(	AnalyzerOptions	opt,
		int	nVal
	)

Change a static code analyzer setting.

Parameters

opt	AnalyzerOptions
nVal	int

Returns: void

Definition at line 28 of file options.cpp.

References analyzerOptsToString(), and Settings::m_settings.

Referenced by OptionsDialog::EvaluateOptions(), and readAnalyzerOptionsFromConfig().

Here is the call graph for this function:

◆ SetCaretBlinkTime()

void Options::SetCaretBlinkTime ( int nTime )

inline

Definition at line 212 of file Options.h.

References Settings::m_settings, and SETTING_V_CARETBLINKTIME.

Referenced by NumeReWindow::InitializeProgramOptions().

◆ SetDebuggerFocusLine()

void Options::SetDebuggerFocusLine ( int nLine )

inline

Definition at line 214 of file Options.h.

References Settings::m_settings, and SETTING_V_FOCUSEDLINE.

Referenced by NumeReWindow::InitializeProgramOptions().

◆ SetEditorFont()

void Options::SetEditorFont ( wxFont font )

inline

Definition at line 186 of file Options.h.

References Settings::m_settings, and SETTING_S_EDITORFONT.

Referenced by NumeReWindow::InitializeProgramOptions().

◆ SetFoldDuringLoading()

void Options::SetFoldDuringLoading ( bool fold )

inline

Definition at line 224 of file Options.h.

References Settings::m_settings, and SETTING_B_FOLDLOADEDFILE.

◆ SetFormatBeforeSaving()

void Options::SetFormatBeforeSaving ( bool formatBeforeSave )

inline

Definition at line 206 of file Options.h.

References Settings::m_settings, and SETTING_B_FORMATBEFORESAVING.

◆ SetHighlightLocalVariables()

void Options::SetHighlightLocalVariables ( bool highlight )

inline

Definition at line 226 of file Options.h.

References Settings::m_settings, and SETTING_B_HIGHLIGHTLOCALS.

◆ SetKeepBackupFile()

void Options::SetKeepBackupFile ( bool keepFile )

inline

Definition at line 210 of file Options.h.

References Settings::m_settings, and SETTING_B_USEREVISIONS.

◆ SetLaTeXRoot()

void Options::SetLaTeXRoot ( const wxString & root )

inline

Definition at line 208 of file Options.h.

References Settings::m_settings, and SETTING_S_LATEXROOT.

Referenced by NumeReWindow::InitializeProgramOptions().

◆ SetLineNumberPrinting()

void Options::SetLineNumberPrinting ( bool printLineNumbers )

inline

Definition at line 200 of file Options.h.

References Settings::m_settings, and SETTING_B_PRINTLINENUMBERS.

◆ SetPrintStyle()

void Options::SetPrintStyle ( int style )

inline

Definition at line 192 of file Options.h.

References Settings::m_settings, SETTING_B_PRINTINCOLOR, and wxSTC_PRINT_COLOURONWHITE.

Referenced by OptionsDialog::EvaluateOptions(), and NumeReWindow::InitializeProgramOptions().

◆ SetSaveBookmarksInSession()

void Options::SetSaveBookmarksInSession ( bool save )

inline

Definition at line 204 of file Options.h.

References Settings::m_settings, Settings::save(), and SETTING_B_SAVEBOOKMARKS.

Here is the call graph for this function:

◆ SetSaveSession()

void Options::SetSaveSession ( bool saveSession )

inline

Definition at line 202 of file Options.h.

References Settings::m_settings, and SETTING_B_SAVESESSION.

◆ SetShowGlobalVariables()

void Options::SetShowGlobalVariables ( bool show )

inline

Definition at line 222 of file Options.h.

References Settings::m_settings, and SETTING_B_GLOBALVARS.

◆ SetShowLinesInStackTrace()

void Options::SetShowLinesInStackTrace ( bool show )

inline

Definition at line 216 of file Options.h.

References Settings::m_settings, and SETTING_B_LINESINSTACK.

◆ SetShowModulesInStackTrace()

void Options::SetShowModulesInStackTrace ( bool show )

inline

Definition at line 218 of file Options.h.

References Settings::m_settings, and SETTING_B_MODULESINSTACK.

◆ SetShowPathOnTabs()

void Options::SetShowPathOnTabs ( bool useText )

inline

Definition at line 198 of file Options.h.

References Settings::m_settings, and SETTING_B_PATHSONTABS.

◆ SetShowProcedureArguments()

void Options::SetShowProcedureArguments ( bool show )

inline

Definition at line 220 of file Options.h.

References Settings::m_settings, and SETTING_B_PROCEDUREARGS.

◆ SetShowToolbarText()

void Options::SetShowToolbarText ( bool useText )

inline

Definition at line 196 of file Options.h.

References Settings::m_settings, and SETTING_B_TOOLBARTEXT.

◆ SetSyntaxStyle()

void Options::SetSyntaxStyle	(	size_t	i,
		const SyntaxStyles &	styles
	)

Update a selected syntax style by converting the passed SyntaxStyles object into a style string and storing it internally.

Parameters

i	size_t
styles	const SyntaxStyles&

Returns: void

Definition at line 133 of file options.cpp.

References Settings::m_settings, syntaxStylesToString(), and SyntaxStyles::to_string().

Referenced by OptionsDialog::InitializeDialog(), OptionsDialog::OnButtonClick(), OptionsDialog::OnColorPickerChange(), OptionsDialog::OnFontCheckClick(), and OptionsDialog::synchronizeColors().

Here is the call graph for this function:

◆ SetTerminalHistorySize()

void Options::SetTerminalHistorySize ( int size )

inline

Definition at line 194 of file Options.h.

References Settings::m_settings, and SETTING_V_BUFFERSIZE.

Referenced by NumeReWindow::InitializeProgramOptions().

◆ syntaxStylesToString()

std::string Options::syntaxStylesToString ( Styles style ) const

private

Convert the syntax style enumeration values into the new settings strings.

Parameters

style Styles

Returns: std::string

Definition at line 396 of file options.cpp.

References SETTING_S_ST_ACTIVELINE, SETTING_S_ST_CLUSTER, SETTING_S_ST_COMMAND, SETTING_S_ST_COMMENT, SETTING_S_ST_CONSOLESTD, SETTING_S_ST_CONSTANT, SETTING_S_ST_CUSTOMFUNC, SETTING_S_ST_DEFVARS, SETTING_S_ST_DOCCOMMENT, SETTING_S_ST_DOCKEYWORD, SETTING_S_ST_FUNCTION, SETTING_S_ST_INCLUDES, SETTING_S_ST_INSTALL, SETTING_S_ST_METHODS, SETTING_S_ST_NUMBER, SETTING_S_ST_OPERATOR, SETTING_S_ST_OPTION, SETTING_S_ST_PROCCOMMAND, SETTING_S_ST_PROCEDURE, SETTING_S_ST_SPECIALVAL, SETTING_S_ST_STANDARD, SETTING_S_ST_STRING, and SETTING_S_ST_STRINGPARSER.

Referenced by GetSyntaxStyle(), readColoursFromConfig(), and SetSyntaxStyle().

◆ toFont()

static wxFont Options::toFont ( const std::string & sFontDescr )

inlinestatic

Definition at line 348 of file Options.h.

Referenced by GetEditorFont(), OptionsDialog::InitializeDialog(), NumeReWindow::OnOptions(), and NumeReHistory::UpdateSyntaxHighlighting().

◆ toString()

static std::string Options::toString ( wxFont font )

inlinestatic

Definition at line 355 of file Options.h.

Referenced by OptionsDialog::EvaluateOptions().

Friends And Related Function Documentation

◆ OptionsDialog

friend class OptionsDialog

friend

Definition at line 179 of file Options.h.

The documentation for this class was generated from the following files:

D:/CPP/numere-source/trunk/common/Options.h
D:/CPP/numere-source/trunk/common/options.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AnalyzerOptions

◆ Styles

Constructor & Destructor Documentation

◆ Options()

◆ ~Options()

Member Function Documentation

◆ analyzerOptsToString()

◆ GetAnalyzerOption()

◆ GetCaretBlinkTime()

◆ GetDebuggerFocusLine()

◆ GetDefaultSyntaxStyle()

◆ GetEditorFont()

◆ GetFoldDuringLoading()

◆ GetFormatBeforeSaving()

◆ GetHighlightLocalVariables()

◆ GetIdByIdentifier()

◆ GetKeepBackupFile()

◆ GetLaTeXRoot()

◆ GetLineNumberPrinting()

◆ GetPrintStyle()

◆ GetSaveBookmarksInSession()

◆ GetSaveSession()

◆ GetShowGlobalVariables()

◆ GetShowLinesInStackTrace()

◆ GetShowModulesInStackTrace()

◆ GetShowPathOnTabs()

◆ GetShowProcedureArguments()

◆ GetShowToolbarText()

◆ GetStyleIdentifier()

◆ GetSyntaxStyle()

◆ GetTerminalHistorySize()

◆ readAnalyzerOptionsFromConfig()

◆ readColoursFromConfig()

◆ SetAnalyzerOption()

◆ SetCaretBlinkTime()

◆ SetDebuggerFocusLine()

◆ SetEditorFont()

◆ SetFoldDuringLoading()

◆ SetFormatBeforeSaving()

◆ SetHighlightLocalVariables()

◆ SetKeepBackupFile()

◆ SetLaTeXRoot()

◆ SetLineNumberPrinting()

◆ SetPrintStyle()

◆ SetSaveBookmarksInSession()

◆ SetSaveSession()

◆ SetShowGlobalVariables()

◆ SetShowLinesInStackTrace()

◆ SetShowModulesInStackTrace()

◆ SetShowPathOnTabs()

◆ SetShowProcedureArguments()

◆ SetShowToolbarText()

◆ SetSyntaxStyle()

◆ SetTerminalHistorySize()

◆ syntaxStylesToString()

◆ toFont()

◆ toString()

Friends And Related Function Documentation

◆ OptionsDialog