]> de.git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blobdiff - qcsrc/common/command/generic.qc
Merge remote branch 'origin/master' into samual/menu_updates
[xonotic/xonotic-data.pk3dir.git] / qcsrc / common / command / generic.qc
index d90a3f7fe9e55b41c2747bbeaed1319d7cb9dd34..d0cd7a3042cd1e993522c1377ff52864bdbbeaeb 100644 (file)
@@ -1,5 +1,5 @@
 // =========================================================
-//  Generic program common command code, reworked by Samual
+//  Generic program common command code, written by Samual
 //  Last updated: December 28th, 2011
 // =========================================================
 
@@ -17,116 +17,10 @@ string GetProgramCommandPrefix(void)
        #endif
 }
 
-#define NUM_MARKUPS    41
-float markup_init;
-string markup_from[NUM_MARKUPS];
-string markup_to[NUM_MARKUPS];
-void GameCommand_MarkupInit()
-{
-       float i;
-       if (markup_init)
-               return;
-       markup_init = 1;
-       i = 0;
-       markup_from[i] = "&alien"; markup_to[i] = "\x12"; ++i;
-       markup_from[i] = "&:-)"; markup_to[i] = "\x13"; ++i;
-       markup_from[i] = "&:-("; markup_to[i] = "\x14"; ++i;
-       markup_from[i] = "&x-P"; markup_to[i] = "\x15"; ++i;
-       markup_from[i] = "&:-/"; markup_to[i] = "\x16"; ++i;
-       markup_from[i] = "&:-D"; markup_to[i] = "\x17"; ++i;
-       markup_from[i] = "&<<"; markup_to[i] = "\x18"; ++i;
-       markup_from[i] = "&>>"; markup_to[i] = "\x19"; ++i;
-       markup_from[i] = "&dot"; markup_to[i] = "\x1a"; ++i;
-       markup_from[i] = "&^_"; markup_to[i] = "\x1b"; ++i;
-       markup_from[i] = "&ysplat"; markup_to[i] = "\x1c"; ++i;
-       markup_from[i] = "&-]"; markup_to[i] = "\x1d"; ++i;
-       markup_from[i] = "&--"; markup_to[i] = "\x1e"; ++i;
-       markup_from[i] = "&[-"; markup_to[i] = "\x1f"; ++i;
-       markup_from[i] = "&s<"; markup_to[i] = "\x2c"; ++i;
-       markup_from[i] = "&s>"; markup_to[i] = "\x2e"; ++i;
-       markup_from[i] = "&<-"; markup_to[i] = "\x7f"; ++i;
-       markup_from[i] = "&[="; markup_to[i] = "\x80"; ++i;
-       markup_from[i] = "&=="; markup_to[i] = "\x81"; ++i;
-       markup_from[i] = "&=]"; markup_to[i] = "\x82"; ++i;
-       markup_from[i] = "&r!"; markup_to[i] = "\x84"; ++i;
-       markup_from[i] = "&|o|"; markup_to[i] = "\x85"; ++i;
-       markup_from[i] = "&|u|"; markup_to[i] = "\x86"; ++i;
-       markup_from[i] = "&|i|"; markup_to[i] = "\x87"; ++i;
-       markup_from[i] = "&|c|"; markup_to[i] = "\x88"; ++i;
-       markup_from[i] = "&[c]"; markup_to[i] = "\x89"; ++i;
-       markup_from[i] = "&[n]"; markup_to[i] = "\x8a"; ++i;
-       markup_from[i] = "&[]"; markup_to[i] = "\x8b"; ++i;
-       markup_from[i] = "&r?"; markup_to[i] = "\x8c"; ++i;
-       markup_from[i] = "&|>"; markup_to[i] = "\x8d"; ++i;
-       markup_from[i] = "&splat0"; markup_to[i] = "\x8e"; ++i;
-       markup_from[i] = "&splat1"; markup_to[i] = "\x8f"; ++i;
-       markup_from[i] = "&[["; markup_to[i] = "\x90"; ++i;
-       markup_from[i] = "&]]"; markup_to[i] = "\x91"; ++i;
-       markup_from[i] = "&splat2"; markup_to[i] = "\x9a"; ++i;
-       markup_from[i] = "&)("; markup_to[i] = "\x9b"; ++i;
-       markup_from[i] = "&splat3"; markup_to[i] = "\x9c"; ++i;
-       markup_from[i] = "&(."; markup_to[i] = "\x9d"; ++i;
-       markup_from[i] = "&.."; markup_to[i] = "\x9e"; ++i;
-       markup_from[i] = "&.)"; markup_to[i] = "\x9f"; ++i;
-       markup_from[i] = "&<|"; markup_to[i] = "\xff"; ++i;
-}
-
-string GameCommand_Markup(string s2)
-{
-       float red, ccase, i, j;
-       string s, s3;
-
-       GameCommand_MarkupInit();
-
-       s = "";
-
-       red = 0;
-       ccase = 0;
-       for(i = 0; i < strlen(s2); ++i)
-       {
-               for(j = 0; j < NUM_MARKUPS; ++j)
-               {
-                       s3 = substring(s2, i, strlen(markup_from[j]));
-                       if (s3 == markup_from[j])
-                       {
-                               s = strcat(s, markup_to[j]);
-                               i += strlen(markup_from[j]) - 1;
-                               break;
-                       }
-               }
-
-               if(j == NUM_MARKUPS)
-               {
-                       if(substring(s2, i, 2) == "&&")
-                       {
-                               s = strcat(s, strconv(ccase, red, red, "&"));
-                               ++i;
-                       }
-                       else if(substring(s2, i, 2) == "&d")
-                       {
-                               red = 2;
-                               ccase = 0;
-                               ++i;
-                       }
-                       else if(substring(s2, i, 2) == "&a")
-                       {
-                               red = 2;
-                               ccase = 2;
-                               ++i;
-                       }
-                       else if(substring(s2, i, 2) == "&n")
-                       {
-                               red = 0;
-                               ccase = 0;
-                               ++i;
-                       }
-                       else
-                               s = strcat(s, strconv(ccase, red, red, substring(s2, i, 1)));
-               }
-       }
 
-       return s;
-}
+// =======================
+//  Command Sub-Functions
+// =======================
 
 void GenericCommand_addtolist(float request, float argc)
 {
@@ -138,30 +32,89 @@ void GenericCommand_addtolist(float request, float argc)
                        
                        if(argc >= 2)
                        {
-                               if(cvar_string(argv(1)) == "") // cvar was empty
+                               string original_cvar = argv(1);
+                               string tmp_string = argv(2);
+                               
+                               if(cvar_string(original_cvar) == "") // cvar was empty
                                {
-                                       cvar_set(argv(1), argv(2));
+                                       cvar_set(original_cvar, tmp_string);
                                }
                                else // add it to the end of the list if the list doesn't already have it
                                {
-                                       argc = tokenizebyseparator(cvar_string(argv(1)), " ");
+                                       argc = tokenizebyseparator(cvar_string(original_cvar), " ");
+                                       
                                        for(i = 0; i < argc; ++i)
-                                               if(argv(i) == argv(2))
+                                               if(argv(i) == tmp_string)
                                                        return; // already in list
                                                        
-                                       cvar_set(argv(1), strcat(argv(2), " ", cvar_string(argv(1))));
+                                       cvar_set(original_cvar, strcat(tmp_string, " ", cvar_string(original_cvar)));
                                }
                                return;
                        }
                }
                        
                default:
-                       // todo
+                       print("Incorrect parameters for ^2addtolist^7\n");
                case CMD_REQUEST_USAGE:
                {
-                       print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " addtolist variable [value]"));
-                       print("  Where 'variable' is what to add to the list,\n");
-                       print("  and 'value' is any extra optional paramaters to add with quotes.");
+                       print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " addtolist variable value"));
+                       print("  Where 'variable' is what to add 'value' to.\n");
+                       print("See also: ^2removefromlist^7\n");
+                       return;
+               }
+       }
+}
+
+void GenericCommand_dumpcommands(float request)
+{
+       switch(request)
+       {
+               case CMD_REQUEST_COMMAND:
+               {
+                       float fh;
+                       string filename = strcat(GetProgramCommandPrefix(), "_dump.txt");
+                       fh = fopen(filename, FILE_WRITE);
+                       
+                       if(fh >= 0)
+                       {
+                               #ifdef SVQC
+                                       CMD_Write("dump of server console commands:\n");
+                                       GameCommand_macro_write_aliases(fh);
+                                       
+                                       CMD_Write("\ndump of networked client only commands:\n");
+                                       ClientCommand_macro_write_aliases(fh);
+                                       
+                                       CMD_Write("\ndump of common commands:\n");
+                                       CommonCommand_macro_write_aliases(fh);
+
+                                       CMD_Write("\ndump of ban commands:\n");
+                                       BanCommand_macro_write_aliases(fh);
+                               #endif
+                                                               
+                               #ifdef CSQC
+                                       CMD_Write("dump of client commands:\n");
+                                       LocalCommand_macro_write_aliases(fh);
+                               #endif
+                               
+                               CMD_Write("\ndump of generic commands:\n");
+                               GenericCommand_macro_write_aliases(fh);
+                               
+                               print("Completed dump of aliases in ^2data/data/", GetProgramCommandPrefix(), "_dump.txt^7.\n");
+                               
+                               fclose(fh);
+                       }
+                       else
+                       {
+                               print("^1Error: ^7Could not dump to file!\n");
+                       }
+                       return;
+               }
+                       
+               default:
+               case CMD_REQUEST_USAGE:
+               {
+                       print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " dumpcommands"));
+                       print("  No arguments required.\n");
                        return;
                }
        }
@@ -198,6 +151,22 @@ void GenericCommand_maplist(float request, float argc)
                                        break; // go to usage
                                }
                                
+                               case "cleanup": // scans maplist and only adds back the ones which are really usable
+                               {
+                                       MapInfo_Enumerate();
+                                       MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), MapInfo_RequiredFlags(), MapInfo_ForbiddenFlags(), 0);
+                                       argc = tokenizebyseparator(cvar_string("g_maplist"), " ");
+                                       
+                                       for(i = 0; i < argc; ++i)
+                                               if(MapInfo_CheckMap(argv(i)))
+                                                       tmp_string = strcat(tmp_string, " ", argv(i));
+                                                       
+                                       tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
+                                       cvar_set("g_maplist", tmp_string);
+                                       
+                                       return;
+                               }
+                               
                                case "remove": // scans maplist and only adds back whatever maps were not provided in argv(2)
                                {
                                        if(argc == 3)
@@ -221,32 +190,77 @@ void GenericCommand_maplist(float request, float argc)
                                        cvar_set("g_maplist", shufflewords(cvar_string("g_maplist")));
                                        return;
                                }
-                               
-                               case "cleanup": // scans maplist and only adds back the ones which are really usable
-                               {
-                                       MapInfo_Enumerate();
-                                       MapInfo_FilterGametype(MapInfo_CurrentGametype(), MapInfo_CurrentFeatures(), MapInfo_RequiredFlags(), MapInfo_ForbiddenFlags(), 0);
-                                       argc = tokenizebyseparator(cvar_string("g_maplist"), " ");
-                                       
-                                       for(i = 0; i < argc; ++i)
-                                               if(MapInfo_CheckMap(argv(i)))
-                                                       tmp_string = strcat(tmp_string, " ", argv(i));
-                                                       
-                                       tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
-                                       cvar_set("g_maplist", tmp_string);
-                                       
-                                       return;
-                               }
                                        
                                default: break;
                        }
                }
                        
                default:
+                       print("Incorrect parameters for ^2maplist^7\n");
                case CMD_REQUEST_USAGE:
                {
-                       print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " maplist command [map]")); // todo
-                       print("  No arguments required.\n");
+                       print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " maplist action [map]"));
+                       print("  Where 'action' is the command to complete,\n");
+                       print("  and 'map' is what it acts upon (if required).\n");
+                       print("  Full list of commands here: \"add, cleanup, remove, shuffle.\"\n");
+                       return;
+               }
+       }
+}
+
+void GenericCommand_nextframe(float request, float arguments, string command)
+{
+       switch(request)
+       {
+               case CMD_REQUEST_COMMAND:
+               {
+                       queue_to_execute_next_frame(substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
+                       return;
+               }
+                       
+               default:
+               case CMD_REQUEST_USAGE:
+               {
+                       print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " nextframe command..."));
+                       print("  Where command will be executed next frame of this VM\n");
+                       return;
+               }
+       }
+}
+
+void GenericCommand_removefromlist(float request, float argc)
+{
+       switch(request)
+       {
+               case CMD_REQUEST_COMMAND:
+               {
+                       if(argc == 3)
+                       {
+                               float i;
+                               string original_cvar = argv(1);
+                               string removal = argv(2);
+                               string tmp_string;
+                               
+                               argc = tokenizebyseparator(cvar_string(original_cvar), " ");
+                               
+                               for(i = 0; i < argc; ++i)
+                                       if(argv(i) != removal)
+                                               tmp_string = strcat(tmp_string, " ", argv(i));
+                                               
+                               tmp_string = substring(tmp_string, 1, strlen(tmp_string) - 1);
+                               cvar_set(original_cvar, tmp_string);
+                               
+                               return;
+                       }
+               }
+                       
+               default:
+                       print("Incorrect parameters for ^2removefromlist^7\n");
+               case CMD_REQUEST_USAGE:
+               {
+                       print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " removefromlist variable value"));
+                       print("  Where 'variable' is what cvar to remove 'value' from.\n");
+                       print("See also: ^2addtolist^7\n");
                        return;
                }
        }
@@ -275,6 +289,7 @@ void GenericCommand_settemp(float request, float argc)
                {
                        print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " settemp \"cvar\" \"arguments\"\n"));
                        print("  Where 'cvar' is the cvar you want to temporarily set with 'arguments'.\n");
+                       print("See also: ^2settemp_restore^7\n");
                        return;
                }
        }
@@ -301,6 +316,7 @@ void GenericCommand_settemp_restore(float request, float argc)
                {
                        print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " settemp_restore\n"));
                        print("  No arguments required.\n");
+                       print("See also: ^2settemp^7\n");
                        return;
                }
        }
@@ -321,7 +337,7 @@ void GenericCommand_(float request)
                default:
                case CMD_REQUEST_USAGE:
                {
-                       print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " ")));
+                       print(strcat("\nUsage:^3 ", GetProgramCommandPrefix(), " "));
                        print("  No arguments required.\n");
                        return;
                }
@@ -335,8 +351,11 @@ void GenericCommand_(float request)
 
 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
 #define GENERIC_COMMANDS(request,arguments,command) \
-       GENERIC_COMMAND("addtolist", GenericCommand_addtolist(request, arguments), "Add a string to a cvar at the end of a list") \
+       GENERIC_COMMAND("addtolist", GenericCommand_addtolist(request, arguments), "Add a string to a cvar") \
+       GENERIC_COMMAND("dumpcommands", GenericCommand_dumpcommands(request), "Dump all commands on the program to *_cmd_dump.txt") \
        GENERIC_COMMAND("maplist", GenericCommand_maplist(request, arguments), "Automatic control of maplist") \
+       GENERIC_COMMAND("nextframe", GenericCommand_nextframe(request, arguments, command), "Execute the given command next frame of this VM") \
+       GENERIC_COMMAND("removefromlist", GenericCommand_removefromlist(request, arguments), "Remove a string from a cvar") \
        GENERIC_COMMAND("rpn", GenericCommand_rpn(request, arguments, command), "RPN calculator") \
        GENERIC_COMMAND("settemp", GenericCommand_settemp(request, arguments), "Temporarily set a value to a cvar which is restored later") \
        GENERIC_COMMAND("settemp_restore", GenericCommand_settemp_restore(request, arguments), "Restore all cvars set by settemp command") \
@@ -374,6 +393,17 @@ float GenericCommand_macro_usage(float argc)
        
        return FALSE;
 }
+
+void GenericCommand_macro_write_aliases(float fh)
+{
+       #define GENERIC_COMMAND(name,function,description) \
+               { CMD_Write_Alias("qc_cmd_svmenu", name, description); }
+       
+       GENERIC_COMMANDS(0, 0, "")
+       #undef GENERIC_COMMAND
+       
+       return;
+}
        
 
 // ===========================================
@@ -393,26 +423,14 @@ float GenericCommand(string command)
        // argv:   0    - 1      - 2     - 3 
        // cmd     vote - master - login - password
        
-       if(strtolower(argv(0)) == "help") 
-       {
-               if(argc == 1) 
-               {
-                       GenericCommand_macro_help();
-                       return TRUE;
-               } 
-               else if(GenericCommand_macro_usage(argc)) // Instead of trying to call a command, we're going to see detailed information about it
-               {
-                       return TRUE;
-               }
-       } 
-       else if(GenericCommand_macro_command(argc, command)) // continue as usual and scan for normal commands
+       if(GenericCommand_macro_command(argc, command)) // continue as usual and scan for normal commands
        {
                return TRUE; // handled by one of the above GenericCommand_* functions
        }
        else if(argc >= 3 && argv(0) == "red")
        {
                s = substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2));
-               localcmd(strcat(argv(1), " ", GameCommand_Markup(s)));
+               localcmd(strcat(argv(1), " ", GenericCommand_markup(s)));
                return TRUE;
        }
        else if(argc >= 3 && crc16(0, argv(0)) == 38566 && crc16(0, strcat(argv(0), argv(0), argv(0))) == 59830)