Cleanup: move preference versioning into own file

It's more convenient to keep version patching in the same place,
this also splits out some function calls from version patching
and supports updating UserDef structs besides the 'U'l global.

3 files changed, 338 insertions, 0 deletions

diff --git a/source/blender/blenloader/BLO_readfile.h b/source/blender/blenloader/BLO_readfile.h
index 9758ec8b560..c9deb628888 100644
--- a/source/blender/blenloader/BLO_readfile.h
+++ b/source/blender/blenloader/BLO_readfile.h
@@ -158,6 +158,9 @@ void BLO_expand_main(void *fdhandle, struct Main *mainvar);
 void BLO_update_defaults_userpref_blend(void);
 void BLO_update_defaults_startup_blend(struct Main *mainvar);
 
+/* Version patch user preferences. */
+void BLO_version_defaults_userpref_blend(struct Main *mainvar, struct UserDef *userdef);
+
 struct BlendThumbnail *BLO_thumbnail_from_file(const char *filepath);
 
 struct Main *BLO_main_from_memfile(struct MemFile *memfile, struct Main *bmain, struct Scene **r_scene);
diff --git a/source/blender/blenloader/CMakeLists.txt b/source/blender/blenloader/CMakeLists.txt
index f2b7f35d353..e0453e71a05 100644
--- a/source/blender/blenloader/CMakeLists.txt
+++ b/source/blender/blenloader/CMakeLists.txt
@@ -59,6 +59,7 @@ set(SRC
 	intern/versioning_280.c
 	intern/versioning_defaults.c
 	intern/versioning_legacy.c
+	intern/versioning_userdef.c
 	intern/writefile.c
 
 	BLO_blend_defs.h
diff --git a/source/blender/blenloader/intern/versioning_userdef.c b/source/blender/blenloader/intern/versioning_userdef.c
new file mode 100644
index 00000000000..e888c23cd0a
--- /dev/null
+++ b/source/blender/blenloader/intern/versioning_userdef.c
@@ -0,0 +1,334 @@
+/*
+ * ***** BEGIN GPL LICENSE BLOCK *****
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ *
+ */
+
+/** \file blender/blenloader/intern/versioning_userdef.c
+ *  \ingroup blenloader
+ *
+ * Version patch user preferences.
+ */
+
+#include <string.h>
+
+#include "BLI_utildefines.h"
+
+#include "DNA_userdef_types.h"
+#include "DNA_curve_types.h"
+#include "DNA_windowmanager_types.h"
+
+#include "BKE_addon.h"
+#include "BKE_colorband.h"
+#include "BKE_main.h"
+
+#include "BLO_readfile.h"  /* Own include. */
+
+#define U (_error_)
+
+/* patching UserDef struct and Themes */
+void BLO_version_defaults_userpref_blend(Main *bmain, UserDef *userdef)
+{
+#define USER_VERSION_ATLEAST(ver, subver) MAIN_VERSION_ATLEAST(bmain, ver, subver)
+
+	/* the UserDef struct is not corrected with do_versions() .... ugh! */
+	if (userdef->wheellinescroll == 0) userdef->wheellinescroll = 3;
+	if (userdef->menuthreshold1 == 0) {
+		userdef->menuthreshold1 = 5;
+		userdef->menuthreshold2 = 2;
+	}
+	if (userdef->tb_leftmouse == 0) {
+		userdef->tb_leftmouse = 5;
+		userdef->tb_rightmouse = 5;
+	}
+	if (userdef->mixbufsize == 0) userdef->mixbufsize = 2048;
+	if (userdef->autokey_mode == 0) {
+		/* 'add/replace' but not on */
+		userdef->autokey_mode = 2;
+	}
+	if (userdef->savetime <= 0) {
+		userdef->savetime = 1;
+// XXX		error(STRINGIFY(BLENDER_STARTUP_FILE)" is buggy, please consider removing it.\n");
+	}
+	if (userdef->gizmo_size == 0) {
+		userdef->gizmo_size = 75;
+		userdef->gizmo_flag |= USER_GIZMO_DRAW;
+	}
+	if (userdef->pad_rot_angle == 0.0f)
+		userdef->pad_rot_angle = 15.0f;
+
+	/* graph editor - unselected F-Curve visibility */
+	if (userdef->fcu_inactive_alpha == 0) {
+		userdef->fcu_inactive_alpha = 0.25f;
+	}
+
+	if (!USER_VERSION_ATLEAST(192, 0)) {
+		strcpy(userdef->sounddir, "/");
+	}
+
+	/* patch to set Dupli Armature */
+	if (!USER_VERSION_ATLEAST(220, 0)) {
+		userdef->dupflag |= USER_DUP_ARM;
+	}
+
+	/* added seam, normal color, undo */
+	if (!USER_VERSION_ATLEAST(235, 0)) {
+		userdef->uiflag |= USER_GLOBALUNDO;
+		if (userdef->undosteps == 0) userdef->undosteps = 32;
+	}
+	if (!USER_VERSION_ATLEAST(236, 0)) {
+		/* illegal combo... */
+		if (userdef->flag & USER_LMOUSESELECT)
+			userdef->flag &= ~USER_TWOBUTTONMOUSE;
+	}
+	if (!USER_VERSION_ATLEAST(240, 0)) {
+		userdef->uiflag |= USER_PLAINMENUS;
+		if (userdef->obcenter_dia == 0) userdef->obcenter_dia = 6;
+	}
+	if (!USER_VERSION_ATLEAST(242, 0)) {
+		/* set defaults for 3D View rotating axis indicator */
+		/* since size can't be set to 0, this indicates it's not saved in startup.blend */
+		if (userdef->rvisize == 0) {
+			userdef->rvisize = 15;
+			userdef->rvibright = 8;
+			userdef->uiflag |= USER_SHOW_GIZMO_AXIS;
+		}
+
+	}
+	if (!USER_VERSION_ATLEAST(244, 0)) {
+		/* set default number of recently-used files (if not set) */
+		if (userdef->recent_files == 0) userdef->recent_files = 10;
+	}
+	if (!USER_VERSION_ATLEAST(245, 3)) {
+		if (userdef->coba_weight.tot == 0)
+			BKE_colorband_init(&userdef->coba_weight, true);
+	}
+	if (!USER_VERSION_ATLEAST(245, 3)) {
+		userdef->flag |= USER_ADD_VIEWALIGNED | USER_ADD_EDITMODE;
+	}
+	if (!USER_VERSION_ATLEAST(250, 0)) {
+		/* adjust grease-pencil distances */
+		userdef->gp_manhattendist = 1;
+		userdef->gp_euclideandist = 2;
+
+		/* adjust default interpolation for new IPO-curves */
+		userdef->ipo_new = BEZT_IPO_BEZ;
+	}
+
+	if (!USER_VERSION_ATLEAST(250, 3)) {
+		/* new audio system */
+		if (userdef->audiochannels == 0)
+			userdef->audiochannels = 2;
+		if (userdef->audiodevice == 0) {
+#ifdef WITH_OPENAL
+			userdef->audiodevice = 2;
+#endif
+#ifdef WITH_SDL
+			userdef->audiodevice = 1;
+#endif
+		}
+		if (userdef->audioformat == 0)
+			userdef->audioformat = 0x24;
+		if (userdef->audiorate == 0)
+			userdef->audiorate = 48000;
+	}
+
+	if (!USER_VERSION_ATLEAST(250, 8)) {
+		wmKeyMap *km;
+
+		for (km = userdef->user_keymaps.first; km; km = km->next) {
+			if (STREQ(km->idname, "Armature_Sketch"))
+				strcpy(km->idname, "Armature Sketch");
+			else if (STREQ(km->idname, "View3D"))
+				strcpy(km->idname, "3D View");
+			else if (STREQ(km->idname, "View3D Generic"))
+				strcpy(km->idname, "3D View Generic");
+			else if (STREQ(km->idname, "EditMesh"))
+				strcpy(km->idname, "Mesh");
+			else if (STREQ(km->idname, "UVEdit"))
+				strcpy(km->idname, "UV Editor");
+			else if (STREQ(km->idname, "Animation_Channels"))
+				strcpy(km->idname, "Animation Channels");
+			else if (STREQ(km->idname, "GraphEdit Keys"))
+				strcpy(km->idname, "Graph Editor");
+			else if (STREQ(km->idname, "GraphEdit Generic"))
+				strcpy(km->idname, "Graph Editor Generic");
+			else if (STREQ(km->idname, "Action_Keys"))
+				strcpy(km->idname, "Dopesheet");
+			else if (STREQ(km->idname, "NLA Data"))
+				strcpy(km->idname, "NLA Editor");
+			else if (STREQ(km->idname, "Node Generic"))
+				strcpy(km->idname, "Node Editor");
+			else if (STREQ(km->idname, "Logic Generic"))
+				strcpy(km->idname, "Logic Editor");
+			else if (STREQ(km->idname, "File"))
+				strcpy(km->idname, "File Browser");
+			else if (STREQ(km->idname, "FileMain"))
+				strcpy(km->idname, "File Browser Main");
+			else if (STREQ(km->idname, "FileButtons"))
+				strcpy(km->idname, "File Browser Buttons");
+			else if (STREQ(km->idname, "Buttons Generic"))
+				strcpy(km->idname, "Property Editor");
+		}
+	}
+
+	if (!USER_VERSION_ATLEAST(252, 3)) {
+		if (userdef->flag & USER_LMOUSESELECT)
+			userdef->flag &= ~USER_TWOBUTTONMOUSE;
+	}
+	if (!USER_VERSION_ATLEAST(252, 4)) {
+		/* default new handle type is auto handles */
+		userdef->keyhandles_new = HD_AUTO;
+	}
+
+	if (!USER_VERSION_ATLEAST(257, 0)) {
+		/* clear "AUTOKEY_FLAG_ONLYKEYINGSET" flag from userprefs,
+		 * so that it doesn't linger around from old configs like a ghost */
+		userdef->autokey_flag &= ~AUTOKEY_FLAG_ONLYKEYINGSET;
+	}
+
+	if (!USER_VERSION_ATLEAST(260, 3)) {
+		/* if new keyframes handle default is stuff "auto", make it "auto-clamped" instead
+		 * was changed in 260 as part of GSoC11, but version patch was wrong
+		 */
+		if (userdef->keyhandles_new == HD_AUTO)
+			userdef->keyhandles_new = HD_AUTO_ANIM;
+
+		/* enable (Cycles) addon by default */
+		BKE_addon_ensure(&userdef->addons, "cycles");
+	}
+
+	if (!USER_VERSION_ATLEAST(261, 4)) {
+		userdef->use_16bit_textures = true;
+	}
+
+	if (!USER_VERSION_ATLEAST(267, 0)) {
+
+		/* GL Texture Garbage Collection */
+		if (userdef->textimeout == 0) {
+			userdef->texcollectrate = 60;
+			userdef->textimeout = 120;
+		}
+		if (userdef->memcachelimit <= 0) {
+			userdef->memcachelimit = 32;
+		}
+		if (userdef->dbl_click_time == 0) {
+			userdef->dbl_click_time = 350;
+		}
+		if (userdef->v2d_min_gridsize == 0) {
+			userdef->v2d_min_gridsize = 35;
+		}
+		if (userdef->dragthreshold == 0)
+			userdef->dragthreshold = 5;
+		if (userdef->widget_unit == 0)
+			userdef->widget_unit = 20;
+		if (userdef->anisotropic_filter <= 0)
+			userdef->anisotropic_filter = 1;
+
+		if (userdef->ndof_sensitivity == 0.0f) {
+			userdef->ndof_sensitivity = 1.0f;
+			userdef->ndof_flag = (NDOF_LOCK_HORIZON | NDOF_SHOULD_PAN | NDOF_SHOULD_ZOOM | NDOF_SHOULD_ROTATE);
+		}
+
+		if (userdef->ndof_orbit_sensitivity == 0.0f) {
+			userdef->ndof_orbit_sensitivity = userdef->ndof_sensitivity;
+
+			if (!(userdef->flag & USER_TRACKBALL))
+				userdef->ndof_flag |= NDOF_TURNTABLE;
+		}
+		if (userdef->tweak_threshold == 0)
+			userdef->tweak_threshold = 10;
+	}
+
+	/* NOTE!! from now on use userdef->versionfile and userdef->subversionfile */
+#undef USER_VERSION_ATLEAST
+#define USER_VERSION_ATLEAST(ver, subver) MAIN_VERSION_ATLEAST(userdef, ver, subver)
+
+	if (!USER_VERSION_ATLEAST(271, 5)) {
+		userdef->pie_menu_radius = 100;
+		userdef->pie_menu_threshold = 12;
+		userdef->pie_animation_timeout = 6;
+	}
+
+	if (!USER_VERSION_ATLEAST(275, 2)) {
+		userdef->ndof_deadzone = 0.1;
+	}
+
+	if (!USER_VERSION_ATLEAST(275, 4)) {
+		userdef->node_margin = 80;
+	}
+
+	if (!USER_VERSION_ATLEAST(278, 6)) {
+		/* Clear preference flags for re-use. */
+		userdef->flag &= ~(
+		    USER_FLAG_NUMINPUT_ADVANCED | USER_FLAG_DEPRECATED_2 | USER_FLAG_DEPRECATED_3 |
+		    USER_FLAG_DEPRECATED_6 | USER_FLAG_DEPRECATED_7 |
+		    USER_FLAG_DEPRECATED_9 | USER_DEVELOPER_UI);
+		userdef->uiflag &= ~(
+		    USER_UIFLAG_DEPRECATED_7);
+		userdef->transopts &= ~(
+		    USER_TR_DEPRECATED_2 | USER_TR_DEPRECATED_3 | USER_TR_DEPRECATED_4 |
+		    USER_TR_DEPRECATED_6 | USER_TR_DEPRECATED_7);
+
+		userdef->uiflag |= USER_LOCK_CURSOR_ADJUST;
+	}
+
+
+	if (!USER_VERSION_ATLEAST(280, 20)) {
+		userdef->gpu_viewport_quality = 0.6f;
+
+		/* Reset theme, old themes will not be compatible with minor version updates from now on. */
+		for (bTheme *btheme = userdef->themes.first; btheme; btheme = btheme->next) {
+			memcpy(btheme, &U_theme_default, sizeof(*btheme));
+		}
+
+		/* Annotations - new layer color
+		 * Replace anything that used to be set if it looks like was left
+		 * on the old default (i.e. black), which most users used
+		 */
+		if ((userdef->gpencil_new_layer_col[3] < 0.1f) || (userdef->gpencil_new_layer_col[0] < 0.1f)) {
+			/* - New color matches the annotation pencil icon
+			 * - Non-full alpha looks better!
+			 */
+			ARRAY_SET_ITEMS(userdef->gpencil_new_layer_col, 0.38f, 0.61f, 0.78f, 0.9f);
+		}
+	}
+
+	/**
+	 * Include next version bump.
+	 */
+	{
+		/* (keep this block even if it becomes empty). */
+	}
+
+	if (userdef->pixelsize == 0.0f)
+		userdef->pixelsize = 1.0f;
+
+	if (userdef->image_draw_method == 0)
+		userdef->image_draw_method = IMAGE_DRAW_METHOD_2DTEXTURE;
+
+	// we default to the first audio device
+	userdef->audiodevice = 0;
+
+	/* Not versioning, just avoid errors. */
+#ifndef WITH_CYCLES
+	BKE_addon_remove_safe(&userdef->addons, "cycles");
+#endif
+	/* this timer uses U */
+// XXX	reset_autosave();
+}