updated config version to '13' and adjusted 'fluxbox-update_configs' accordingly

our users should migrate seamlessly to our new windows-cycling behaviour
without losing their current way of doing things. so, 'fluxbox-update_configs'
tries its best to add '(workspace=[current])' wherever it looks like a valid
place for it. such changed lines are marked by '!! FBCV13' at the end and can
be easily spotted in case the updater got it wrong.

addtional changes:

* added '-check' to 'fluxbox-update_configs' to check the version number in
  '~/.fluxbox/init' vs. the version number of 'fluxbox-update_configs'

* moved the update-code for each version into its own function, easier
  housekeeping
This commit is contained in:
Mathias Gumz 2010-09-11 22:04:15 +02:00
parent 51f054e777
commit 24e4e98dbe
2 changed files with 504 additions and 332 deletions

View file

@ -602,7 +602,7 @@ void Fluxbox::setupConfigFiles() {
if (create_windowmenu)
FbTk::FileUtil::copyFile(DEFAULT_WINDOWMENU, windowmenu_file.c_str());
#define CONFIG_VERSION 12
#define CONFIG_VERSION 13
FbTk::Resource<int> config_version(m_resourcemanager, 0,
"session.configVersion", "Session.ConfigVersion");
if (*config_version < CONFIG_VERSION) {

View file

@ -70,18 +70,12 @@ string read_file(const string& filename);
void write_file(const string& filename, const string &contents);
void save_all_files();
int run_updates(int old_version, FbTk::ResourceManager &rm) {
int new_version = old_version;
FbTk::Resource<string> rc_keyfile(rm, "~/.fluxbox/keys",
"session.keyFile", "Session.KeyFile");
FbTk::Resource<string> rc_appsfile(rm, "~/.fluxbox/apps",
"session.appsFile", "Session.AppsFile");
/*------------------------------------------------------------------*\
\*------------------------------------------------------------------*/
string appsfilename = FbTk::StringUtil::expandFilename(*rc_appsfile);
string keyfilename = FbTk::StringUtil::expandFilename(*rc_keyfile);
if (old_version < 1) { // add mouse events to keys file
void update_add_mouse_evens_to_keys(FbTk::ResourceManager& rm,
const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) {
string whole_keyfile = read_file(keyfilename);
string new_keyfile = "";
@ -114,10 +108,12 @@ int run_updates(int old_version, FbTk::ResourceManager &rm) {
new_keyfile += whole_keyfile; // don't forget user's old keybindings
write_file(keyfilename, new_keyfile);
new_version = 1;
}
}
void update_move_groups_entries_to_apps_file(FbTk::ResourceManager& rm,
const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) {
if (old_version < 2) { // move groups entries to apps file
FbTk::Resource<string> rc_groupfile(rm, "~/.fluxbox/groups",
"session.groupFile", "Session.GroupFile");
string groupfilename = FbTk::StringUtil::expandFilename(*rc_groupfile);
@ -149,10 +145,12 @@ int run_updates(int old_version, FbTk::ResourceManager &rm) {
new_appsfile += whole_appsfile;
write_file(appsfilename, new_appsfile);
new_version = 2;
}
}
void update_move_toolbar_wheeling_to_keys_file(FbTk::ResourceManager& rm,
const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) {
if (old_version < 3) { // move toolbar wheeling to keys file
string whole_keyfile = read_file(keyfilename);
string new_keyfile = "";
// let's put our new keybindings first, so they're easy to find
@ -185,10 +183,12 @@ int run_updates(int old_version, FbTk::ResourceManager &rm) {
if (keep_changes)
write_file(keyfilename, new_keyfile);
new_version = 3;
}
}
if (old_version < 4) { // move modkey to keys file
void update_move_modkey_to_keys_file(FbTk::ResourceManager& rm,
const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) {
string whole_keyfile = read_file(keyfilename);
string new_keyfile = "";
// let's put our new keybindings first, so they're easy to find
@ -217,35 +217,42 @@ int run_updates(int old_version, FbTk::ResourceManager &rm) {
new_keyfile += whole_keyfile; // don't forget user's old keybindings
write_file(keyfilename, new_keyfile);
new_version = 4;
}
}
void update_window_patterns_for_iconbar(FbTk::ResourceManager& rm,
const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) {
if (old_version < 5) { // window patterns for iconbar
// this needs to survive after going out of scope
// it won't get freed, but that's ok
FbTk::Resource<string> *rc_mode =
new FbTk::Resource<string>(rm, "Workspace",
"session.screen0.iconbar.mode",
"Session.Screen0.Iconbar.Mode");
if (strcasecmp((**rc_mode).c_str(), "None") == 0)
std::string mode = FbTk::StringUtil::toLower(**rc_mode);
if (mode == "none")
*rc_mode = "none";
else if (strcasecmp((**rc_mode).c_str(), "Icons") == 0)
else if (mode == "icons")
*rc_mode = "{static groups} (minimized=yes)";
else if (strcasecmp((**rc_mode).c_str(), "NoIcons") == 0)
else if (mode == "noicons")
*rc_mode = "{static groups} (minimized=no)";
else if (strcasecmp((**rc_mode).c_str(), "WorkspaceIcons") == 0)
else if (mode == "workspaceicons")
*rc_mode = "{static groups} (minimized=yes) (workspace)";
else if (strcasecmp((**rc_mode).c_str(), "WorkspaceNoIcons") == 0)
else if (mode == "workspacenoicons")
*rc_mode = "{static groups} (minimized=no) (workspace)";
else if (strcasecmp((**rc_mode).c_str(), "AllWindows") == 0)
else if (mode == "allwindows")
*rc_mode = "{static groups}";
else
*rc_mode = "{static groups} (workspace)";
new_version = 5;
}
}
if (old_version < 6) { // move titlebar actions to keys file
void update_move_titlebar_actions_to_keys_file(FbTk::ResourceManager& rm,
const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) {
string whole_keyfile = read_file(keyfilename);
string new_keyfile = "";
// let's put our new keybindings first, so they're easy to find
@ -278,10 +285,11 @@ int run_updates(int old_version, FbTk::ResourceManager &rm) {
write_file(keyfilename, new_keyfile);
new_version = 6;
}
}
if (old_version < 7) { // added StartTabbing command
void update_added_starttabbing_command(FbTk::ResourceManager& rm,
const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) {
string whole_keyfile = read_file(keyfilename);
string new_keyfile = "";
// let's put our new keybindings first, so they're easy to find
@ -290,29 +298,37 @@ int run_updates(int old_version, FbTk::ResourceManager &rm) {
new_keyfile += whole_keyfile; // don't forget user's old keybindings
write_file(keyfilename, new_keyfile);
}
new_version = 7;
}
if (old_version < 8) { // disable icons in tabs for backwards compatibility
void update_disable_icons_in_tabs_for_backwards_compatibility(FbTk::ResourceManager& rm,
const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) {
FbTk::Resource<bool> *show =
new FbTk::Resource<bool>(rm, false,
"session.screen0.tabs.usePixmap",
"Session.Screen0.Tabs.UsePixmap");
if (!*show) // only change if the setting didn't already exist
*show = false;
new_version = 8;
}
}
void update_change_format_of_split_placement_menu(FbTk::ResourceManager& rm,
const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) {
if (old_version < 9) { // change format of slit placement menu
FbTk::Resource<string> *placement =
new FbTk::Resource<string>(rm, "BottomRight",
"session.screen0.slit.placement",
"Session.Screen0.Slit.Placement");
FbTk::Resource<string> *direction =
new FbTk::Resource<string>(rm, "Vertical",
"session.screen0.slit.direction",
"Session.Screen0.Slit.Direction");
if (strcasecmp((**direction).c_str(), "vertical") == 0) {
if (strcasecmp((**placement).c_str(), "BottomRight") == 0)
*placement = "RightBottom";
@ -323,10 +339,14 @@ int run_updates(int old_version, FbTk::ResourceManager &rm) {
else if (strcasecmp((**placement).c_str(), "TopLeft") == 0)
*placement = "LeftTop";
}
new_version = 9;
}
}
void update_update_keys_file_for_nextwindow_syntax_changes(FbTk::ResourceManager& rm,
const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) {
if (old_version < 10) { // update keys file for NextWindow syntax changes
string whole_keyfile = read_file(keyfilename);
size_t pos = 0;
@ -376,10 +396,13 @@ int run_updates(int old_version, FbTk::ResourceManager &rm) {
}
write_file(keyfilename, whole_keyfile);
new_version = 10;
}
}
if (old_version < 11) { // update keys for OnLeftGrip/OnRightGrip/OnWindowBorder
void update_keys_for_ongrip_onwindowborder(FbTk::ResourceManager& rm,
const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) {
string whole_keyfile = read_file(keyfilename);
string new_keyfile = "";
@ -393,11 +416,13 @@ int run_updates(int old_version, FbTk::ResourceManager &rm) {
new_keyfile += "\n"; // just for good looks
write_file(keyfilename, new_keyfile);
}
new_version = 11;
}
if (old_version < 12) { // update keys for ActivateTab
void update_keys_for_activetab(FbTk::ResourceManager& rm,
const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) {
string whole_file = read_file(keyfilename);
string new_keyfile = "";
@ -409,7 +434,141 @@ int run_updates(int old_version, FbTk::ResourceManager &rm) {
new_keyfile += "\n"; // just for good looks
write_file(keyfilename, new_keyfile);
new_version = 12;
}
// NextWindow {static groups} => NextWindow {static groups} (workspace=[current])
void update_limit_nextwindow_to_current_workspace(FbTk::ResourceManager& rm,
const FbTk::FbString& keyfilename, const FbTk::FbString& appsfilename) {
string whole_file = read_file(keyfilename);
string new_keyfile = "";
new_keyfile += "! fluxbox-update_configs added '(workspace=[current])' to (Next|Prev)(Window|Group)\n";
new_keyfile += "! check lines marked by 'FBCV13' if they are correctly updated\n";
const char* pos = whole_file.c_str();
string last_word;
enum { SCAN, COMMENT, CMD, OPEN_STATIC_GROUP_OR_PATTERN, CLOSE_STATIC_GROUP };
int state = SCAN;
bool mark_line_change = false;
for ( ; *pos; ++pos) {
new_keyfile += *pos;
char c = tolower(*pos);
switch (state) {
case SCAN:
if (c == '{' || c == ':') // ':NextWindow' or 'MacroCmd {NextWindow'
state = CMD;
break;
case CMD:
if (isspace(c) || c == '}' || c == '#' || c == '!' ) {
if (last_word == "nextwindow" || last_word == "nextgroup" ||
last_word == "prevwindow" || last_word == "prevgroup") {
// ':NewWindow[\n!#]' or 'MacroCmd {NextWindow}'
if (c == '\n' || c == '#' || c == '!' || c == '}') {
new_keyfile.insert(new_keyfile.size() - 1, " (workspace=[current])");
mark_line_change = true;
state = SCAN;
} else {
state = OPEN_STATIC_GROUP_OR_PATTERN;
}
} else {
state = SCAN;
last_word.clear();
}
} else { // possible '(next|prev)(group|window)'
last_word += c;
}
break;
case OPEN_STATIC_GROUP_OR_PATTERN:
if (c == '{') { // NextWindow {static group}
state = CLOSE_STATIC_GROUP;
} else if (c == '(') { // NextWindow (foo=bar)
new_keyfile += "workspace=[current]) (";
mark_line_change = true;
state = SCAN;
} else if (c == '}') { // MacroCmd {NextWindow }
new_keyfile.insert(new_keyfile.size() - 1, " (workspace=[current]) ");
mark_line_change = true;
state = SCAN;
}
break;
case CLOSE_STATIC_GROUP:
if (c == '}') {
new_keyfile += " (workspace=[current]) ";
mark_line_change = true;
state = SCAN;
}
break;
};
if (*pos == '\n') { // a new line or a comment resets the state
if (mark_line_change)
new_keyfile.insert(new_keyfile.size() - 1, " !! FBCV13 !!");
mark_line_change = false;
last_word.clear();
state = SCAN;
} else if (*pos == '#' || *pos == '!') {
last_word.clear();
state = COMMENT;
}
}
new_keyfile += "\n"; // just for good looks
write_file(keyfilename, new_keyfile);
}
/*------------------------------------------------------------------*\
\*------------------------------------------------------------------*/
struct Update {
int version;
void (*update)(FbTk::ResourceManager& rm, const FbTk::FbString&, const FbTk::FbString&);
};
const Update UPDATES[] = {
{ 1, update_add_mouse_evens_to_keys },
{ 2, update_move_groups_entries_to_apps_file },
{ 3, update_move_toolbar_wheeling_to_keys_file },
{ 4, update_move_modkey_to_keys_file },
{ 5, update_window_patterns_for_iconbar },
{ 6, update_move_titlebar_actions_to_keys_file },
{ 7, update_added_starttabbing_command },
{ 8, update_disable_icons_in_tabs_for_backwards_compatibility },
{ 9, update_change_format_of_split_placement_menu },
{ 10, update_update_keys_file_for_nextwindow_syntax_changes },
{ 11, update_keys_for_ongrip_onwindowborder },
{ 12, update_keys_for_activetab },
{ 13, update_limit_nextwindow_to_current_workspace }
};
/*------------------------------------------------------------------*\
\*------------------------------------------------------------------*/
int run_updates(int old_version, FbTk::ResourceManager &rm) {
int new_version = old_version;
FbTk::Resource<string> rc_keyfile(rm, "~/.fluxbox/keys",
"session.keyFile", "Session.KeyFile");
FbTk::Resource<string> rc_appsfile(rm, "~/.fluxbox/apps",
"session.appsFile", "Session.AppsFile");
string appsfilename = FbTk::StringUtil::expandFilename(*rc_appsfile);
string keyfilename = FbTk::StringUtil::expandFilename(*rc_keyfile);
int i;
for (i = 0; i < sizeof(UPDATES) / sizeof(Update); ++i) {
if (old_version < UPDATES[i].version) {
UPDATES[i].update(rm, keyfilename, appsfilename);
new_version = UPDATES[i].version;
}
}
return new_version;
@ -419,13 +578,15 @@ int main(int argc, char **argv) {
string rc_filename;
set<string> style_filenames;
int i = 1;
bool check = 0;
pid_t fb_pid = 0;
FbTk::NLSInit("fluxbox.cat");
_FB_USES_NLS;
for (; i < argc; i++) {
if (strcmp(argv[i], "-rc") == 0) {
string arg = argv[i];
if (arg == "-rc") {
// look for alternative rc file to use
if ((++i) >= argc) {
@ -435,16 +596,19 @@ int main(int argc, char **argv) {
}
rc_filename = argv[i];
} else if (strcmp(argv[i], "-pid") == 0) {
} else if (arg == "-pid") {
if ((++i) >= argc) {
// need translations for this, too
cerr<<"the -pid option requires a numeric argument"<<endl;
} else
fb_pid = atoi(argv[i]);
} else if (strcmp(argv[i], "-help") == 0 || strcmp(argv[i], "-h") == 0) {
} else if (arg == "-check") {
check = true;
} else if (arg == "-help" || arg == "-h") {
// no NLS translations yet -- we'll just have to use English for now
cout << " -rc <string>\t\t\tuse alternate resource file.\n"
<< " -pid <int>\t\t\ttell fluxbox to reload configuration.\n"
<< " -check\t\t\tcheck version of this tool and the fluxbox config.\n"
<< " -help\t\t\t\tdisplay this help text and exit.\n\n"
<< endl;
exit(0);
@ -472,6 +636,14 @@ int main(int argc, char **argv) {
FbTk::Resource<int> config_version(resource_manager, 0,
"session.configVersion", "Session.ConfigVersion");
if (check) {
cout << rc_filename << ": " << *config_version << endl
<< "fluxbox-update_configs: " << UPDATES[sizeof(UPDATES)/sizeof(Update) - 1].version << endl;
exit(0);
}
int old_version = *config_version;
int new_version = run_updates(old_version, resource_manager);
if (new_version > old_version) {