xournalpp/src/control/settings/Settings.h

/*
 * Xournal++
 *
 * Xournal Settings
 *
 * @author Xournal++ Team
 * https://github.com/xournalpp/xournalpp
 *
 * @license GNU GPLv2 or later
 */

#pragma once

#include "control/Tool.h"
#include "model/Font.h"

#include <Path.h>

#include <config-dev.h>
#include <libxml/xmlreader.h>
#include <map>
#include <portaudio.h>

enum AttributeType
{
	ATTRIBUTE_TYPE_NONE,
	ATTRIBUTE_TYPE_STRING,
	ATTRIBUTE_TYPE_INT,
	ATTRIBUTE_TYPE_DOUBLE,
	ATTRIBUTE_TYPE_INT_HEX,
	ATTRIBUTE_TYPE_BOOLEAN,
};

// use this as a bit flag
enum ScrollbarHideType
{
	SCROLLBAR_HIDE_NONE = 0,
	SCROLLBAR_HIDE_HORIZONTAL = 1 << 1,
	SCROLLBAR_HIDE_VERTICAL = 1 << 2,
	SCROLLBAR_HIDE_BOTH = SCROLLBAR_HIDE_HORIZONTAL | SCROLLBAR_HIDE_VERTICAL
};

class ButtonConfig;
class InputDevice;

extern const char* BUTTON_NAMES[];
const int BUTTON_COUNT = 7;


class SAttribute
{
public:
	SAttribute();
	SAttribute(const SAttribute& attrib);
	virtual ~SAttribute();

public:
	XOJ_TYPE_ATTRIB;

	string sValue;
	int iValue;
	double dValue;

	AttributeType type;

	string comment;
};

class SElement;

class __RefSElement
{
public:
	__RefSElement();
	virtual ~__RefSElement();

public:
	void ref();
	void unref();

private:
	XOJ_TYPE_ATTRIB;

	std::map<string, SAttribute> attributes;
	std::map<string, SElement> children;

	int refcount;

	friend class SElement;
};

class SElement
{
public:
	SElement();
	SElement(const SElement& elem);
	virtual ~SElement();

public:
	void operator=(const SElement& elem);

	void clear();

	SElement& child(string name);

	void setIntHex(const string name, const int value);
	void setInt(const string name, const int value);
	void setDouble(const string name, const double value);
	void setBool(const string name, const bool value);
	void setString(const string name, const string value);

	void setComment(const string name, const string comment);

	bool getInt(const string name, int& value);
	bool getDouble(const string name, double& value);
	bool getBool(const string name, bool& value);
	bool getString(const string name, string& value);

	std::map<string, SAttribute>& attributes();
	std::map<string, SElement>& children();

private:
	XOJ_TYPE_ATTRIB;

	__RefSElement* element;
};

class Settings
{
public:
	Settings(Path filename);
	virtual ~Settings();

public:
	bool load();
	void parseData(xmlNodePtr cur, SElement& elem);

	void save();

private:
	void loadDefault();
	void parseItem(xmlDocPtr doc, xmlNodePtr cur);

	xmlNodePtr savePropertyDouble(const gchar* key, double value,
								  xmlNodePtr parent);
	xmlNodePtr saveProperty(const gchar* key, int value, xmlNodePtr parent);
	xmlNodePtr saveProperty(const gchar* key, const gchar* value,
							xmlNodePtr parent);

	void saveData(xmlNodePtr root, string name, SElement& elem);

	void saveButtonConfig();
	void loadButtonConfig();

public:
	// Getter- / Setter
	bool isPressureSensitivity();
	void setPressureSensitivity(gboolean presureSensitivity);

	/**
	 * Getter, enable/disable
	 */
	bool isZoomGesturesEnabled();
	void setZoomGesturesEnabled(bool enable);

	/**
	 * The last used font
	 */
	XojFont& getFont();
	void setFont(const XojFont& font);

	/**
	 * The selected Toolbar
	 */
	void setSelectedToolbar(string name);
	string getSelectedToolbar();

	/**
	 * Set the Zoomstep for one step in percent
	 */
	void setZoomStep(double zoomStep);
	double getZoomStep();

	/**
	 * Set the Zoomstep for Ctrl + Scroll in percent
	 */
	void setZoomStepScroll(double zoomStepScroll);
	double getZoomStepScroll();

	/**
	 * Sets the screen resolution in DPI
	 */
	void setDisplayDpi(int dpi);
	int getDisplayDpi();

	/**
	 * Dark theme for white-coloured icons
	 */
	void setDarkTheme(bool dark);
	bool isDarkTheme();

	/**
	 * The last saved path
	 */
	void setLastSavePath(Path p);
	Path getLastSavePath();

	/**
	 * The last open path
	 */
	void setLastOpenPath(Path p);
	Path const& getLastOpenPath() const;

	void setLastImagePath(Path p);
	Path getLastImagePath();

	void setMainWndSize(int width, int height);
	void setMainWndMaximized(bool max);
	int getMainWndWidth();
	int getMainWndHeight();
	bool isMainWndMaximized();

	bool isSidebarVisible();
	void setSidebarVisible(bool visible);

	int getSidebarWidth();
	void setSidebarWidth(int width);

	bool isSidebarOnRight();
	void setSidebarOnRight(bool right);

	bool isScrollbarOnLeft();
	void setScrollbarOnLeft(bool right);

	bool isMenubarVisible();
	void setMenubarVisible(bool visible);

	void setShowPairedPages(bool showPairedPages);
	bool isShowPairedPages();

	void setPresentationMode(bool presentationMode);
	bool isPresentationMode();

	void setPairsOffset(int numPairsOffset);
	int getPairsOffset();

	void setViewColumns(int numColumns);
	int getViewColumns();

	void setViewRows(int numRows);
	int getViewRows();

	void setViewFixedRows(bool viewFixedRows);
	bool isViewFixedRows();

	void setViewLayoutVert(bool vert);
	bool getViewLayoutVert();

	void setViewLayoutR2L(bool r2l);
	bool getViewLayoutR2L();

	void setViewLayoutB2T(bool b2t);
	bool getViewLayoutB2T();


	bool isAutloadPdfXoj();
	void setAutoloadPdfXoj(bool load);

	int getAutosaveTimeout();
	void setAutosaveTimeout(int autosave);
	bool isAutosaveEnabled();
	void setAutosaveEnabled(bool autosave);

	bool getAddVerticalSpace();
	void setAddVerticalSpace(bool space);
	int  getAddVerticalSpaceAmount();
	void setAddVerticalSpaceAmount(int pixels);

	bool getAddHorizontalSpace();
	void setAddHorizontalSpace(bool space);
	int  getAddHorizontalSpaceAmount();
	void setAddHorizontalSpaceAmount(int pixels);

	bool getDrawDirModsEnabled();
	void setDrawDirModsEnabled(bool enable);
	int  getDrawDirModsRadius();
	void setDrawDirModsRadius(int pixels);

	bool isTouchWorkaround();
	void setTouchWorkaround(bool b);

	bool isSnapRotation();
	void setSnapRotation(bool b);
	double getSnapRotationTolerance();
	void setSnapRotationTolerance(double tolerance);

	bool isSnapGrid();
	void setSnapGrid(bool b);
	double getSnapGridTolerance();
	void setSnapGridTolerance(double tolerance);

	bool isShowBigCursor();
	void setShowBigCursor(bool b);

	bool isHighlightPosition();
	void setHighlightPosition(bool highlight);

	ScrollbarHideType getScrollbarHideType();
	void setScrollbarHideType(ScrollbarHideType type);

	bool isScrollbarFadeoutDisabled();
	void setScrollbarFadeoutDisabled(bool disable);

	string getDefaultSaveName();
	void setDefaultSaveName(string name);

	ButtonConfig* getButtonConfig(int id);

	ButtonConfig* getEraserButtonConfig();
	ButtonConfig* getMiddleButtonConfig();
	ButtonConfig* getRightButtonConfig();
	ButtonConfig* getTouchButtonConfig();
	ButtonConfig* getDefaultButtonConfig();
	ButtonConfig* getStylusButton1Config();
	ButtonConfig* getStylusButton2Config();

	string getFullscreenHideElements();
	void setFullscreenHideElements(string elements);

	string getPresentationHideElements();
	void setPresentationHideElements(string elements);

	int getBorderColor();
	void setBorderColor(int color);

	int getSelectionColor();
	void setSelectionColor(int color);

	int getBackgroundColor();
	void setBackgroundColor(int color);

	int getPdfPageCacheSize();
	void setPdfPageCacheSize(int size);

	string getPageTemplate();
	void setPageTemplate(string pageTemplate);

	string getAudioFolder();
	void setAudioFolder(string audioFolder);

	PaDeviceIndex getAudioInputDevice();
	void setAudioInputDevice(PaDeviceIndex deviceIndex);

	PaDeviceIndex getAudioOutputDevice();
	void setAudioOutputDevice(PaDeviceIndex deviceIndex);

	double getAudioSampleRate();
	void setAudioSampleRate(double sampleRate);

	double getAudioGain();
	void setAudioGain(double gain);

	string getPluginEnabled();
	void setPluginEnabled(string pluginEnabled);

	string getPluginDisabled();
	void setPluginDisabled(string pluginDisabled);

	bool getExperimentalInputSystemEnabled();
	void setExperimentalInputSystemEnabled(bool systemEnabled);

	bool getInputSystemTPCButtonEnabled();
	void setInputSystemTPCButtonEnabled(bool tpcButtonEnabled);

	bool getInputSystemDrawOutsideWindowEnabled();
	void setInputSystemDrawOutsideWindowEnabled(bool drawOutsideWindowEnabled);

	void loadDeviceClasses();
	void saveDeviceClasses();
	void setDeviceClassForDevice(GdkDevice* device, int deviceClass);
	void setDeviceClassForDevice(const string& deviceName, GdkInputSource deviceSource, int deviceClass);
	int getDeviceClassForDevice(GdkDevice* device);
	int getDeviceClassForDevice(const string& deviceName, GdkInputSource deviceSource);
	std::vector<InputDevice> getKnownInputDevices();

	/**
	 * Get name, e.g. "cm"
	 */
	string getSizeUnit();

	/**
	 * Get size index in XOJ_UNITS
	 */
	int getSizeUnitIndex();

	/**
	 * Set Unit, e.g. "cm"
	 */
	void setSizeUnit(string sizeUnit);

	/**
	 * Set size index in XOJ_UNITS
	 */
	void setSizeUnitIndex(int sizeUnitId);

	/**
	 * Set StrokeFilter enabled
	 */
	void setStrokeFilterEnabled(bool enabled);

	/**
	 * Get StrokeFilter enabled
	 */
	bool getStrokeFilterEnabled();


	/**
	 * get strokeFilter settings
	 */
	void getStrokeFilter( int* strokeFilterIgnoreTime, double* strokeFilterIgnoreLength, int* strokeFilterSuccessiveTime);

	/**
	 * configure stroke filter
	 */
	void setStrokeFilter( int strokeFilterIgnoreTime, double strokeFilterIgnoreLength, int strokeFilterSuccessiveTime);

	/**
	 * Set DoActionOnStrokeFilter enabled
	 */
	void setDoActionOnStrokeFiltered(bool enabled);

	/**
	 * Get DoActionOnStrokeFilter enabled
	 */
	bool getDoActionOnStrokeFiltered();

		/**
	 * Set TrySelectOnStrokeFilter enabled
	 */
	void setTrySelectOnStrokeFiltered(bool enabled);

	/**
	 * Get TrySelectOnStrokeFilter enabled
	 */
	bool getTrySelectOnStrokeFiltered();
	
public:
	// Custom settings
	SElement& getCustomElement(string name);

	/**
	 * Call this after you have done all custom settings changes
	 */
	void customSettingsChanged();

	/**
	 * Do not save settings until transactionEnd() is called
	 */
	void transactionStart();

	/**
	 * Stop transaction and save settings
	 */
	void transactionEnd();

private:

	/**
	 * Not implemented, do not use
	 * @param settings
	 */
	Settings(const Settings& settings);

	/**
	 * Not implemented, do not use
	 * @param settings
	 */
	void operator=(const Settings& settings);

private:
	XOJ_TYPE_ATTRIB;

	/**
	 *  The config filename
	 */
	Path filename;

private:
	/**
	 * The settings tree
	 */
	std::map<string, SElement> data;

	/**
	 *  Use pen pressure to control stroke width?
	 */
	bool pressureSensitivity;

	/**
	 * If the touch zoom gestures are enabled
	 */
	bool zoomGesturesEnabled;

	/**
	 *  If the sidebar is visible
	 */
	bool showSidebar;

	/**
	 *  The Width of the Sidebar
	 */
	int sidebarWidth;

	/**
	 *  If the sidebar is on the right
	 */
	bool sidebarOnRight;

	/**
	 *  Show a better visible cursor for pen
	 */
	bool showBigCursor;

	/**
	 * Show a yellow circle around the cursor
	 */
	bool highlightPosition;

	/**
	 * If the user uses a dark-themed DE, he should enable this
	 * (white icons)
	 */
	bool darkTheme;

	/**
	 * If the menu bar is visible on startup
	 */
	 bool menubarVisible;

	/**
	 *  Hide the scrollbar
	 */
	ScrollbarHideType scrollbarHideType;

	/**
	 * Disable scrollbar fade out (overlay scrolling)
	 */
	bool disableScrollbarFadeout;

	/**
	 *  The selected Toolbar name
	 */
	string selectedToolbar;

	/**
	 *  The last saved folder
	 */
	Path lastSavePath;

	/**
	 *  The last opened folder
	 */
	Path lastOpenPath;

	/**
	 *  The last "insert image" folder
	 */
	Path lastImagePath;

	/**
	 * The last used font
	 */
	XojFont font;

	/**
	 * Zoomstep for one step
	 */
	double zoomStep;

	/**
	 * Zoomstep for Ctrl + Scroll zooming
	 */
	double zoomStepScroll;

	/**
	 * The display resolution, in pixels per inch
	 */
	gint displayDpi;

	/**
	 *  If the window is maximized
	 */
	bool maximized;

	/**
	 * Width of the main window
	 */
	int mainWndWidth;

	/**
	 * Height of the main window
	 */
	int mainWndHeight;

	/**
	 * Show the scrollbar on the left side
	 */
	bool scrollbarOnLeft;

	/**
	 *  Pairs pages
	 */
	bool showPairedPages;

	/**
	 *  Sets presentation mode
	 */
	bool presentationMode;

	/**
	 *  Offsets first page ( to align pairing )
	 */
	int numPairsOffset;

	/**
	 *  Use when fixed number of columns
	 */
	int numColumns;

	/**
	 *  Use when fixed number of rows
	 */
	int numRows;

	/**
	 *  USE  fixed rows, otherwise fixed columns
	 */
	bool viewFixedRows;

	/**
	 *  Layout Vertical then Horizontal
	 */
	bool layoutVertical;

	/**
	 *  Layout pages right to left
	 */
	bool layoutRightToLeft;

	/**
	 *  Layout Bottom to Top
	 */
	bool layoutBottomToTop;




	/**
	 * Automatically load filename.pdf.xoj / .pdf.xopp instead of filename.pdf (true/false)
	 */
	bool autoloadPdfXoj;

	/**
	 * Automatically save documents for crash recovery each x minutes
	 */
	int autosaveTimeout;

	/**
	 *  Enable automatic save
	 */
	bool autosaveEnabled;

	/**
	 * Allow scroll outside the page display area (horizontal)
	 */
	bool addHorizontalSpace;

	/**
	 * How much allowance to scroll outside the page display area (either side of )
	 */
	int addHorizontalSpaceAmount;

	/**
	 * Allow scroll outside the page display area (vertical)
	 */
	bool addVerticalSpace;

	/** How much allowance to scroll outside the page display area (above and below)
	*/
	int addVerticalSpaceAmount;

	/**
	 * Emulate modifier keys based on initial direction of drawing tool ( for Rectangle, Ellipse etc. )
	 */
	bool drawDirModsEnabled;

	/**
	 * Radius at which emulated modifiers are locked on for the rest of drawing operation
	 */
	int drawDirModsRadius;

	/**
	 * Rotation snapping enabled by default
	 */
	bool snapRotation;

	/**
	 * grid snapping enabled by default
	 */
	bool snapGrid;

	/**
	 * Default name if you save a new document
	 */
	string defaultSaveName; // should be string - don't change to path

	/**
	 * The button config
	 *
	 * 0: eraser
	 * 1: middle button
	 * 2: right button
	 * 3: touch screen
	 * 4: default
	 * 5: Pen Button 1
	 * 6: Pen Button 2
	 */
	ButtonConfig* buttonConfig[BUTTON_COUNT];

	/**
	 * Which gui elements are hidden if you are in Fullscreen mode,
	 * separated by a colon (,)
	 */
	string fullscreenHideElements;
	string presentationHideElements;

	/**
	 *  The count of pages which will be cached
	 */
	int pdfPageCacheSize;

	/**
	 * The color to draw borders on selected elements
	 * (Page, insert image selection etc.)
	 */
	int selectionBorderColor;

	/**
	 * Color for Text selection, Stroke selection etc.
	 */
	int selectionMarkerColor;

	/**
	 * The color for Xournal page background
	 */
	int backgroundColor;

	/**
	 * Page template String
	 */
	string pageTemplate;

	/**
	 * Unit, see XOJ_UNITS
	 */
	string sizeUnit;

	/**
	 * Audio folder for audio recording
	 */
	string audioFolder;

	/**
	 * Snap tolerance for the graph/dotted grid
	 */
	double snapGridTolerance;

	/**
	 * Rotation epsilon for rotation snapping feature
	 */
	double snapRotationTolerance;

	/**
	 * Do not use GTK Scrolling / Touch handling
	 */
	bool touchWorkaround;

	/**
	 * The index of the audio device used for recording
	 */
	PaDeviceIndex audioInputDevice;

	/**
	 * The index of the audio device used for playback
	 */
	PaDeviceIndex audioOutputDevice;

	/**
	 * The sample rate used for recording
	 */
	double audioSampleRate;

	/**
	 * The gain by which to amplify the recorded audio samples
	 */
	double audioGain;

	/**
	 * List of enabled plugins (only the one which are not enabled by default)
	 */
	string pluginEnabled;

	/**
	 * List of disabled plugins (only the one which are not disabled by default)
	 */
	string pluginDisabled;


	/**
	 * Used to filter strokes of short time and length unless successive in order to do something else ( i.e. select object, float Toolbox menu ).
	 * strokeFilterIgnoreLength			this many mm ( double )
	 * strokeFilterIgnoreTime 			within this time (ms)  will be ignored..
	 * strokeFilterSuccessiveTime		...unless successive within this time.
	 */
	int strokeFilterIgnoreTime;
	double strokeFilterIgnoreLength;
	int strokeFilterSuccessiveTime;
	bool strokeFilterEnabled;
	bool doActionOnStrokeFiltered;
	bool trySelectOnStrokeFiltered;

	/**
	 * Whether the new experimental input system is activated
	 */
	bool experimentalInputSystemEnabled;

	/**
	 * Whether Wacom parameter TabletPCButton is enabled
	 */
	bool inputSystemTPCButton;

	bool inputSystemDrawOutsideWindow;

	std::map<string, std::pair<int, GdkInputSource>> inputDeviceClasses = {};

	/**
	 * "Transaction" running, do not save until the end is reached
	 */
	bool inTransaction;


};