script_doc.hpp

Go to the documentation of this file.

#include "../console.h"
 
#include <Strings/components/utils/io/io.h>
 
namespace Blam::Resources::Console
{
    class ScriptDocCommand : public BlamConsoleCommand
    {
    public:
        ScriptDocCommand()
        {
            name = "script_doc";
            description = "saves a file called hs_doc.txt with parameters for all script commands and globals.";
            aliases = { "hs_doc" };
            syntax = "script_doc [quiet]";
 
            type = BlamCommandType::Builtin;
        }
 
        BlamResult Execute(std::vector<std::string> arguments)
        {
            bool quiet = false;
 
            if (arguments.size() > 0)
            {
                if (arguments[0] == "quiet")
                {
                    quiet = true;
                }
            }
 
            std::string doc_contents = "";
 
            // built-in commands
            {
                doc_contents += "== Built-in Commands ==";
                doc_contents += "\n\n\n\n";
 
                std::map<std::string, BlamConsoleCommand*> commands = Blam::Resources::Console::GetCommandList();
                std::map<std::string, BlamConsoleCommand*>::iterator it;
 
                for (it = commands.begin(); it != commands.end(); it++)
                {
                    BlamConsoleCommand* command = it->second;
 
                    // Syntax line
                    {
                        std::string syntax_line = "(";
 
                        syntax_line += command->name;
 
                        if (command->syntax != "")
                        {
                            syntax_line += " ";
                            syntax_line += command->syntax;
                        }
 
                        syntax_line += ")";
 
                        doc_contents += syntax_line;
                    }
 
                    // Aliases line
                    if (command->aliases.size() > 0)
                    {
                        doc_contents += "\n\n";
 
                        std::string aliases_line = "aliases: [";
 
                        for (int i = 0; i < command->aliases.size(); i++)
                        {
                            std::string alias = command->aliases.at(i);
 
                            aliases_line += alias;
 
                            if (i != command->aliases.size() - 1)
                            {
                                aliases_line += ", ";
                            }
                        }
 
                        aliases_line += "]";
 
                        doc_contents += aliases_line;
                    }
                    
                    // Description line
                    if (command->description != "")
                    {
                        doc_contents += "\n\n";
                        doc_contents += command->description;
                    }
                    
                    // Network-safety line
                    {
                        doc_contents += "\n\n";
                        doc_contents += "NETWORK SAFE: Unspecified (networking is not available yet)";
                    }
 
                    doc_contents += "\n\n\n\n";
                }
            }
 
            // script functions
            {
                doc_contents += "== Commands ==";
                doc_contents += "\n\n\n\n";
 
                // none of these yet...
            }
 
            // global variables
            {
                doc_contents += "== Script Globals ==";
                doc_contents += "\n\n\n\n";
 
                std::map<std::string, BlamEngineGlobal>* globals = Blam::Globals::GetGlobalsList();
                std::map<std::string, BlamEngineGlobal>::iterator it;
 
                for (it = globals->begin(); it != globals->end(); it++)
                {
                    // name line
                    {
                        std::string global_line = "(" + it->second.name + " <" + Blam::Globals::GetGlobalTypeLabel(it->second.type) + ">)";
 
                        if (it->second.read_only)
                        {
                            global_line += " [protected]";
                        }
 
                        doc_contents += global_line;
                    }
 
                    if (it->second.info != "")
                    {
                        doc_contents += "\n";
                        doc_contents += it->second.info;
                    }
 
                    doc_contents += "\n\n";
                }
            }
 
            std::string file_path = USER_DATA_PATH(BlamUserDataFolder::DataRoot) + "/hs_doc.txt";
 
            BlamStrings::Utils::IO::CreateNewFile(file_path, doc_contents);
 
            if (!quiet)
            {
                BlamStrings::Utils::IO::OpenFile(file_path);
            }
 
            //WinExec(std::string("notepad " + file_path).c_str(), SW_SHOWDEFAULT);
 
            return BlamResult::Success_OK;
        }
    };
}